autocomplete: Add AutocompleteProvider::Type enum.

chrome/browser/autocomplete/autocomplete_provider.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_PROVIDER_H_
 #define CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_PROVIDER_H_
 
 #include <string>
 
 #include "base/basictypes.h"
@@ skipping 155 matching lines @@
 // *~: Partial matches get a score on a sliding scale from about 575-1125 based
 //     on how many times the URL for the Extension App has been typed and how
 //     many of the letters match.
 //
 // A single result provider for the autocomplete system.  Given user input, the
 // provider decides what (if any) matches to return, their relevance, and their
 // classifications.
 class AutocompleteProvider
     : public base::RefCountedThreadSafe<AutocompleteProvider> {
  public:
+  // Different AutocompleteProvider implementations.
+  enum Type {
+    TYPE_BUILTIN          = 1 << 0,
+    TYPE_EXTENSION_APP    = 1 << 1,

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

Nit: I guess this should be EXTENSION_APPS for consistency with existing code

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

I noticed this too.  The class is ExtensionAppController, though, and the file
is extension_app_provider.h.  I don't see the string being used anywhere, so
I've changed it to "ExtensionApp".

+    TYPE_HISTORY_CONTENTS = 1 << 2,
+    TYPE_HISTORY_QUICK    = 1 << 3,
+    TYPE_HISTORY_URL      = 1 << 4,
+    TYPE_KEYWORD          = 1 << 5,
+    TYPE_SEARCH           = 1 << 6,
+    TYPE_SHORTCUTS        = 1 << 7,
+    TYPE_ZERO_SUGGEST     = 1 << 8,
+  };
+
+  // Returns a string describing a particular AutocompleteProvider type.
+  static const char* TypeToString(Type type);

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

Nit: Google style guide says constructors go before static methods.

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

Done.

 
   AutocompleteProvider(AutocompleteProviderListener* listener,
                        Profile* profile,
-                       const char* name);
+                       Type type);
 
   // Called to start an autocomplete query.  The provider is responsible for
   // tracking its matches for this query and whether it is done processing the
   // query.  When new matches are available or the provider finishes, it
   // calls the controller's OnProviderUpdate() method.  The controller can then
   // get the new matches using the provider's accessors.
   // Exception: Matches available immediately after starting the query (that
   // is, synchronously) do not cause any notifications to be sent.  The
   // controller is expected to check for these without prompting (since
   // otherwise, starting each provider running would result in a flurry of
@@ skipping 11 matching lines @@
   // done.  If the provider caches any results, it should clear the cache based
   // on the value of |clear_cached_results|.
   virtual void Stop(bool clear_cached_results);
 
   // Returns the set of matches for the current query.
   const ACMatches& matches() const { return matches_; }
 
   // Returns whether the provider is done processing the query.
   bool done() const { return done_; }
 
-  // Returns the name of this provider.
-  const std::string& name() const { return name_; }
+  // Returns this provider's type.
+  Type type() const { return type(); }
+  const char* name() const { return TypeToString(type_); }

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

Nit: This isn't a true cheap-accessor, so it should be Name().  Or we can scrap
entirely -- forcing callers to call TypeToString() is OK with me.

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

Done.

 
   // Returns the enum equivalent to the name of this provider.
   metrics::OmniboxEventProto_ProviderType AsOmniboxEventProviderType() const;
 
   // Called to delete a match and the backing data that produced it.  This
   // match should not appear again in this or future queries.  This can only be
   // called for matches the provider marks as deletable.  This should only be
   // called when no query is running.
   // NOTE: Remember to call OnProviderUpdate() if matches_ is updated.
   virtual void DeleteMatch(const AutocompleteMatch& match);
@@ skipping 35 matching lines @@
   void UpdateStarredStateOfMatches();
 
   // The profile associated with the AutocompleteProvider.  Reference is not
   // owned by us.
   Profile* profile_;
 
   AutocompleteProviderListener* listener_;
   ACMatches matches_;
   bool done_;
 
-  // The name of this provider.  Used for logging.
-  std::string name_;
+  Type type_;
 
  private:
   DISALLOW_COPY_AND_ASSIGN(AutocompleteProvider);
 };
 
 typedef std::vector<AutocompleteProvider*> ACProviders;
 
 #endif  // CHROME_BROWSER_AUTOCOMPLETE_AUTOCOMPLETE_PROVIDER_H_