Rename VisitDatabaseObserver to HistoryServiceObserver

chrome/browser/history/history_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_HISTORY_HISTORY_SERVICE_H_
 #define CHROME_BROWSER_HISTORY_HISTORY_SERVICE_H_
 
 #include <set>
 #include <vector>
 
@@ skipping 46 matching lines @@
 class VisitedLinkMaster;
 }
 
 namespace history {
 
 class HistoryBackend;
 class HistoryClient;
 class HistoryDatabase;
 class HistoryDBTask;
 class HistoryQueryTest;
-class HistoryServiceObserver;
 class HistoryTest;
 class InMemoryHistoryBackend;
 class InMemoryURLIndex;
 class InMemoryURLIndexTest;
 class URLDatabase;
-class VisitDatabaseObserver;
 class VisitFilter;
 struct DownloadRow;
 struct HistoryAddPageArgs;
 struct HistoryDetails;
 struct KeywordSearchTermVisit;
 
 }  // namespace history
 
 // The history service records page titles, and visit times, as well as
 // (eventually) information about autocomplete.
 //
 // This service is thread safe. Each request callback is invoked in the
 // thread that made the request.
 class HistoryService : public content::NotificationObserver,
                        public syncer::SyncableService,
                        public KeyedService,
                        public visitedlink::VisitedLinkDelegate {
  public:
   // Miscellaneous commonly-used types.
   typedef std::vector<PageUsageData*> PageUsageDataList;
 
+  class Observer {
+   public:
+    Observer() {}
+    virtual ~Observer() {}
+
+    // Called when user visits an URL.
+    //
+    // The |row| ID will be set to the value that is currently in effect in the
+    // main history database. |redirects| is the list of redirects leading up to
+    // the URL. If we have a redirect chain A -> B -> C and user is visiting C,
+    // then |redirects[0]=B| and |redirects[1]=A|. If there are no redirects,
+    // |redirects| is an empty vector.
+    virtual void OnURLVisited(ui::PageTransition transition,
+                              const history::URLRow& row,
+                              const history::RedirectList& redirects,
+                              base::Time visit_time) {}
+
+    // Called on changes to the VisitDatabase.
+    virtual void OnAddVisit(const history::BriefVisitInfo& info) {}
+  };
+
   // Must call Init after construction. The |history::HistoryClient| object
   // must be valid for the whole lifetime of |HistoryService|.
   explicit HistoryService(history::HistoryClient* client, Profile* profile);
   // The empty constructor is provided only for testing.
   HistoryService();
 
   virtual ~HistoryService();
 
   // Initializes the history service, returning true on success. On false, do
   // not call any other functions. The given directory will be used for storing
@@ skipping 319 matching lines @@
   // Deletes all URL and search term entries matching the given |term| and
   // |keyword_id|.
   void DeleteMatchingURLsForKeyword(history::KeywordID keyword_id,
                                     const base::string16& term);
 
   // Bookmarks -----------------------------------------------------------------
 
   // Notification that a URL is no longer bookmarked.
   void URLsNoLongerBookmarked(const std::set<GURL>& urls);
 
-  // HistoryServiceObserver ----------------------------------------------------
+  // Observers -----------------------------------------------------------------
 
-  // Adds/Removes an HistoryServiceObserver.
-  void AddHistoryServiceObserver(history::HistoryServiceObserver* observer);
-  void RemoveHistoryServiceObserver(history::HistoryServiceObserver* observer);
+  // Adds/Removes an Observer.
+  void AddObserver(Observer* observer);
+  void RemoveObserver(Observer* observer);
 
   // Generic Stuff -------------------------------------------------------------
 
   // Schedules a HistoryDBTask for running on the history backend thread. See
   // HistoryDBTask for details on what this does. Takes ownership of |task|.
   virtual void ScheduleDBTask(scoped_ptr<history::HistoryDBTask> task,
                               base::CancelableTaskTracker* tracker);
 
-  // Adds or removes observers for the VisitDatabase.
-  void AddVisitDatabaseObserver(history::VisitDatabaseObserver* observer);
-  void RemoveVisitDatabaseObserver(history::VisitDatabaseObserver* observer);
-
-  void NotifyVisitDBObserversOnAddVisit(const history::BriefVisitInfo& info);
-
   // This callback is invoked when favicon change for urls.
   typedef base::Callback<void(const std::set<GURL>&)> OnFaviconChangedCallback;
 
   // Add a callback to the list. The callback will remain registered until the
   // returned Subscription is destroyed. This must occurs before HistoryService
   // is destroyed.
   scoped_ptr<base::CallbackList<void(const std::set<GURL>&)>::Subscription>
       AddFaviconChangedCallback(const OnFaviconChangedCallback& callback)
       WARN_UNUSED_RESULT;
 
@@ skipping 126 matching lines @@
 
   // Notification from the backend that it has finished loading. Sends
   // notification (NOTIFY_HISTORY_LOADED) and sets backend_loaded_ to true.
   void OnDBLoaded();
 
   // Helper function for getting URL information.
   // Reads a URLRow from in-memory database. Returns false if database is not
   // available or the URL does not exist.
   bool GetRowForURL(const GURL& url, history::URLRow* url_row);
 
-  // HistoryServiceObserver ----------------------------------------------------
+  // Observers -----------------------------------------------------------------
 
-  // Notify all HistoryServiceObservers registered that user is visiting a URL.
+  // Notify all Observers registered that user is visiting a URL.
   // The |row| ID will be set to the value that is currently in effect in the
   // main history database. |redirects| is the list of redirects leading up to
   // the URL. If we have a redirect chain A -> B -> C and user is visiting C,
   // then |redirects[0]=B| and |redirects[1]=A|. If there are no redirects,
   // |redirects| is an empty vector.
   void NotifyURLVisited(ui::PageTransition transition,
                         const history::URLRow& row,
                         const history::RedirectList& redirects,
                         base::Time visit_time);
 
+  // Notify all Observers registered that the VisitDatabase was changed.
+  void NotifyAddVisit(const history::BriefVisitInfo& info);
+
   // Favicon -------------------------------------------------------------------
 
   // These favicon methods are exposed to the FaviconService. Instead of calling
   // these methods directly you should call the respective method on the
   // FaviconService.
 
   // Used by FaviconService to get the favicon bitmaps from the history backend
   // whose edge sizes most closely match |desired_sizes| for |icon_types|. If
   // |desired_sizes| has a '0' entry, the largest favicon bitmap for
   // |icon_types| is returned. The returned FaviconBitmapResults will have at
@@ skipping 264 matching lines @@
 
   // Cached values from Init(), used whenever we need to reload the backend.
   base::FilePath history_dir_;
   bool no_db_;
 
   // The index used for quick history lookups.
   // TODO(mrossetti): Move in_memory_url_index out of history_service.
   // See http://crbug.com/138321
   scoped_ptr<history::InMemoryURLIndex> in_memory_url_index_;
 
-  ObserverList<history::HistoryServiceObserver> history_service_observers_;
-  ObserverList<history::VisitDatabaseObserver> visit_database_observers_;
-
+  ObserverList<Observer> observers_;
   base::CallbackList<void(const std::set<GURL>&)>
       favicon_changed_callback_list_;
 
   history::DeleteDirectiveHandler delete_directive_handler_;
 
   // All vended weak pointers are invalidated in Cleanup().
   base::WeakPtrFactory<HistoryService> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(HistoryService);
 };
 
 #endif  // CHROME_BROWSER_HISTORY_HISTORY_SERVICE_H_