Abstract history dependencies on bookmarks through HistoryClient

chrome/browser/history/expire_history_backend.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_HISTORY_EXPIRE_HISTORY_BACKEND_H_
 #define CHROME_BROWSER_HISTORY_EXPIRE_HISTORY_BACKEND_H_
 
 #include <queue>
 #include <set>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/time/time.h"
 #include "chrome/browser/history/history_types.h"
 
-class BookmarkService;
 class GURL;
 class TestingProfile;
 
 namespace history {
 
 class ArchivedDatabase;
+class HistoryClient;
 class HistoryDatabase;
 struct HistoryDetails;
 class ThumbnailDatabase;
 
 // Delegate used to broadcast notifications to the main thread.
 class BroadcastNotificationDelegate {
  public:
   // Schedules a broadcast of the given notification on the application main
   // thread.
   virtual void BroadcastNotifications(int type,
@@ skipping 23 matching lines @@
 
 // Helper component to HistoryBackend that manages expiration and deleting of
 // history, as well as moving data from the main database to the archived
 // database as it gets old.
 //
 // It will automatically start periodically archiving old history once you call
 // StartArchivingOldStuff().
 class ExpireHistoryBackend {
  public:
   // The delegate pointer must be non-NULL. We will NOT take ownership of it.
-  // BookmarkService may be NULL. The BookmarkService is used when expiring
-  // URLs so that we don't remove any URLs or favicons that are bookmarked
-  // (visits are removed though).
+  // HistoryClient may be NULL. The HistoryClient is used when expiring URLS so
+  // that we don't remove any URLs or favicons that are bookmarked (visits are
+  // removed though).
   ExpireHistoryBackend(BroadcastNotificationDelegate* delegate,
-                       BookmarkService* bookmark_service);
+                       HistoryClient* history_client);
   ~ExpireHistoryBackend();
 
   // Completes initialization by setting the databases that this class will use.
   void SetDatabases(HistoryDatabase* main_db,
                     ArchivedDatabase* archived_db,
                     ThumbnailDatabase* thumb_db);
 
   // Begins periodic expiration of history older than the given threshold. This
   // will continue until the object is deleted.
   void StartArchivingOldStuff(base::TimeDelta expiration_threshold);
@@ skipping 160 matching lines @@
   // be more history to expire with the current time threshold (it does not
   // indicate success or failure).
   bool ArchiveSomeOldHistory(base::Time end_time,
                              const ExpiringVisitsReader* reader,
                              int max_visits);
 
   // Tries to detect possible bad history or inconsistencies in the database
   // and deletes items. For example, URLs with no visits.
   void ParanoidExpireHistory();
 
-  // Returns the BookmarkService, blocking until it is loaded. This may return
-  // NULL.
-  BookmarkService* GetBookmarkService();
+  // Returns the HistoryClient, blocking until the bookmarks are loaded. This
+  // may return NULL during testing.
+  HistoryClient* GetHistoryClient();
 
   // Initializes periodic expiration work queue by populating it with with tasks
   // for all known readers.
   void InitWorkQueue();
 
   // Returns the reader for all visits. This method is only used by the unit
   // tests.
   const ExpiringVisitsReader* GetAllVisitsReader();
 
   // Returns the reader for AUTO_SUBFRAME visits. This method is only used by
@@ skipping 24 matching lines @@
   // determine what to do at an iteration, as well as populate it for future
   // iterations.
   std::queue<const ExpiringVisitsReader*> work_queue_;
 
   // Readers for various types of visits.
   // TODO(dglazkov): If you are adding another one, please consider reorganizing
   // into a map.
   scoped_ptr<ExpiringVisitsReader> all_visits_reader_;
   scoped_ptr<ExpiringVisitsReader> auto_subframe_visits_reader_;
 
-  // The BookmarkService; may be null. This is owned by the Profile.
+  // The HistoryClient; may be NULL.
   //
-  // Use GetBookmarkService to access this, which makes sure the service is
-  // loaded.
-  BookmarkService* bookmark_service_;
+  // Use GetHistoryClient to access this, which makes sure the bookmarks are
+  // loaded before returning.
+  HistoryClient* history_client_;
 
   DISALLOW_COPY_AND_ASSIGN(ExpireHistoryBackend);
 };
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_EXPIRE_HISTORY_BACKEND_H_