Split keyword related parts of WebDataService as KeywordWebDataService

chrome/browser/search_engines/template_url_service.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_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_H_
 #define CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_H_
 
 #include <list>
 #include <map>
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/callback_list.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/observer_list.h"
 #include "base/prefs/pref_change_registrar.h"
-#include "chrome/browser/webdata/web_data_service.h"
+#include "chrome/browser/webdata/keyword_web_data_service.h"
 #include "components/google/core/browser/google_url_tracker.h"
 #include "components/keyed_service/core/keyed_service.h"
 #include "components/search_engines/default_search_manager.h"
+#include "components/search_engines/template_url.h"
 #include "components/search_engines/template_url_id.h"
+#include "components/webdata/common/web_data_service_consumer.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "sync/api/sync_change.h"
 #include "sync/api/syncable_service.h"
 
 class GURL;
 class PrefService;
 class Profile;
 class SearchHostToURLsMap;
 class SearchTermsData;
 class TemplateURL;
 struct TemplateURLData;
 class TemplateURLServiceObserver;
 
 namespace syncer {
 class SyncData;
 class SyncErrorFactory;
 }
 
 namespace history {
 struct URLVisitedDetails;
 }
 
 // TemplateURLService is the backend for keywords. It's used by
 // KeywordAutocomplete.
 //
 // TemplateURLService stores a vector of TemplateURLs. The TemplateURLs are
-// persisted to the database maintained by WebDataService. *ALL* mutations
-// to the TemplateURLs must funnel through TemplateURLService. This allows
-// TemplateURLService to notify listeners of changes as well as keep the
-// database in sync.
+// persisted to the database maintained by KeywordWebDataService.
+// *ALL* mutations to the TemplateURLs must funnel through TemplateURLService.
+// This allows TemplateURLService to notify listeners of changes as well as keep
+// the database in sync.
 //
 // There is a TemplateURLService per Profile.
 //
 // TemplateURLService does not load the vector of TemplateURLs in its
 // constructor (except for testing). Use the Load method to trigger a load.
 // When TemplateURLService has completed loading, observers are notified via
 // OnTemplateURLServiceChanged, or by a callback registered prior to calling
 // the Load method.
 //
 // TemplateURLService takes ownership of any TemplateURL passed to it. If there
-// is a WebDataService, deletion is handled by WebDataService, otherwise
-// TemplateURLService handles deletion.
+// is a KeywordWebDataService, deletion is handled by KeywordWebDataService,
+// otherwise TemplateURLService handles deletion.
 
 class TemplateURLService : public WebDataServiceConsumer,
                            public KeyedService,
                            public content::NotificationObserver,
                            public syncer::SyncableService {
  public:
   typedef std::map<std::string, std::string> QueryTerms;
   typedef std::vector<TemplateURL*> TemplateURLVector;
   // Type for a static function pointer that acts as a time source.
   typedef base::Time(TimeProvider)();
@@ skipping 198 matching lines @@
   void set_loaded(bool value) { loaded_ = value; }
 #endif
 
   // Whether or not the keywords have been loaded.
   bool loaded() { return loaded_; }
 
   // Notification that the keywords have been loaded.
   // This is invoked from WebDataService, and should not be directly
   // invoked.
   virtual void OnWebDataServiceRequestDone(
-      WebDataService::Handle h,
+      KeywordWebDataService::Handle h,
       const WDTypedResult* result) OVERRIDE;
 
   // Returns the locale-direction-adjusted short name for the given keyword.
   // Also sets the out param to indicate whether the keyword belongs to an
   // Omnibox extension.
   base::string16 GetKeywordShortName(const base::string16& keyword,
                                      bool* is_omnibox_api_extension_keyword);
 
   // content::NotificationObserver implementation.
   virtual void Observe(int type,
@@ skipping 382 matching lines @@
 
   // Whether the keywords have been loaded.
   bool loaded_;
 
   // Set when the web data service fails to load properly.  This prevents
   // further communication with sync or writing to prefs, so we don't persist
   // inconsistent state data anywhere.
   bool load_failed_;
 
   // If non-zero, we're waiting on a load.
-  WebDataService::Handle load_handle_;
+  KeywordWebDataService::Handle load_handle_;
 
   // Service used to store entries.
-  scoped_refptr<WebDataService> service_;
+  scoped_refptr<KeywordWebDataService> web_data_service_;
 
   // All visits that occurred before we finished loading. Once loaded
   // UpdateKeywordSearchTermsForURL is invoked for each element of the vector.
   std::vector<history::URLVisitedDetails> visits_to_add_;
 
   // Once loaded, the default search provider.  This is a pointer to a
   // TemplateURL owned by |template_urls_|.
   TemplateURL* default_search_provider_;
 
   // A temporary location for the DSE until Web Data has been loaded and it can
@@ skipping 20 matching lines @@
   // true, we ignore any local search engine changes, since we triggered them.
   bool processing_syncer_changes_;
 
   // Sync's syncer::SyncChange handler. We push all our changes through this.
   scoped_ptr<syncer::SyncChangeProcessor> sync_processor_;
 
   // Sync's error handler. We use it to create a sync error.
   scoped_ptr<syncer::SyncErrorFactory> sync_error_factory_;
 
   // A set of sync GUIDs denoting TemplateURLs that have been removed from this
-  // model or the underlying WebDataService prior to MergeDataAndStartSyncing.
+  // model or the underlying KeywordWebDataService prior to
+  // MergeDataAndStartSyncing.
   // This set is used to determine what entries from the server we want to
   // ignore locally and return a delete command for.
   std::set<std::string> pre_sync_deletes_;
 
   // This is used to log the origin of changes to the default search provider.
   // We set this value to increasingly specific values when we know what is the
   // cause/origin of a default search change.
   DefaultSearchChangeOrigin dsp_change_origin_;
 
   // Stores a list of callbacks to be run after TemplateURLService has loaded.
   base::CallbackList<void(void)> on_loaded_callbacks_;
 
   // Helper class to manage the default search engine.
   DefaultSearchManager default_search_manager_;
 
   scoped_ptr<GoogleURLTracker::Subscription> google_url_updated_subscription_;
 
   DISALLOW_COPY_AND_ASSIGN(TemplateURLService);
 };
 
 #endif  // CHROME_BROWSER_SEARCH_ENGINES_TEMPLATE_URL_SERVICE_H_