HQP Refactoring (in Preparation for SQLite Cache)

chrome/browser/history/history_backend.h

 // Copyright (c) 2011 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_BACKEND_H_
 #define CHROME_BROWSER_HISTORY_HISTORY_BACKEND_H_
 #pragma once
 
 #include <string>
 #include <utility>
 
 #include "base/file_path.h"
 #include "base/gtest_prod_util.h"
 #include "base/memory/mru_cache.h"
 #include "base/memory/scoped_ptr.h"
 #include "chrome/browser/history/archived_database.h"
 #include "chrome/browser/history/expire_history_backend.h"
 #include "chrome/browser/history/history_database.h"
 #include "chrome/browser/history/history_marshaling.h"
 #include "chrome/browser/history/history_types.h"
 #include "chrome/browser/history/text_database_manager.h"
 #include "chrome/browser/history/thumbnail_database.h"
 #include "chrome/browser/history/visit_tracker.h"
 #include "chrome/browser/search_engines/template_url_id.h"
 #include "sql/init_status.h"
 
 class BookmarkService;
 struct DownloadPersistentStoreInfo;
+class Profile;
 class TestingProfile;
 struct ThumbnailScore;
 
 namespace history {
 
 class CommitLaterTask;
 class HistoryPublisher;
 
 // *See the .cc file for more information on the design.*
 //
@@ skipping 57 matching lines @@
   // See the definition of BroadcastNotificationsCallback above. This function
   // takes ownership of the callback pointer.
   //
   // |id| is used to communicate with the delegate, to identify which
   // backend is calling the method.
   //
   // |bookmark_service| is used to determine bookmarked URLs when deleting and
   // may be NULL.
   //
   // This constructor is fast and does no I/O, so can be called at any time.
-  HistoryBackend(const FilePath& history_dir,
+  HistoryBackend(Profile* profile,
+                 const FilePath& history_dir,
                  int id,
                  Delegate* delegate,
                  BookmarkService* bookmark_service);
 
   // Must be called after creation but before any objects are created. If this
   // fails, all other functions will fail as well. (Since this runs on another
   // thread, we don't bother returning failure.)
   //
-  // |languages| gives a list of language encodings with which the history
-  // URLs and omnibox searches are interpreted.
-  // |force_fail| can be set during unittests to unconditionally fail to init.
+  // |languages| gives the languages used to break search terms and history
+  // page titles into separate words. |force_fail| can be set during unittests
+  // to unconditionally fail to init.
   void Init(const std::string& languages, bool force_fail);
 
   // Notification that the history system is shutting down. This will break
   // the refs owned by the delegate and any pending transaction so it will
   // actually be deleted.
   void Closing();
 
   // See NotifyRenderProcessHostDestruction.
   void NotifyRenderProcessHostDestruction(const void* host);
 
@@ skipping 121 matching lines @@
   void UpdateDownload(int64 received_bytes, int32 state, int64 db_handle);
   void UpdateDownloadPath(const FilePath& path, int64 db_handle);
   void CreateDownload(scoped_refptr<DownloadCreateRequest> request,
                       int32 id,
                       const DownloadPersistentStoreInfo& info);
   void RemoveDownload(int64 db_handle);
   void RemoveDownloadsBetween(const base::Time remove_begin,
                               const base::Time remove_end);
   void RemoveDownloads(const base::Time remove_end);
 
+  // InMemoryURLIndex ----------------------------------------------------------
+
+  // Returns the quick history index.
+  history::InMemoryURLIndex* InMemoryIndex() const {
+    return in_memory_url_index_.get();
+  }
+
   // Segment usage -------------------------------------------------------------
 
   void QuerySegmentUsage(scoped_refptr<QuerySegmentUsageRequest> request,
                          const base::Time from_time,
                          int max_result_count);
   void DeleteOldSegmentData();
   void SetSegmentPresentationIndex(SegmentID segment_id, int index);
 
   // Keyword search terms ------------------------------------------------------
 
@@ skipping 265 matching lines @@
   BookmarkService* GetBookmarkService();
 
   // If there is a favicon for |page_url| and one of the types in |icon_types|,
   // |favicon| is set appropriately and true is returned.
   bool GetFaviconFromDB(const GURL& page_url,
                         int icon_types,
                         FaviconData* favicon);
 
   // Data ----------------------------------------------------------------------
 
+  Profile* profile_;  // The profile may be NULL during unittests.

[Peter Kasting, 2011/10/05 00:11:42]

Where do you use this?

[mrossetti, 2011/10/07 17:04:14]

Only for initializing the InMemoryURLIndex instance, which takes place in the
ctor, so I've removed the data member.

On 2011/10/05 00:11:42, Peter Kasting wrote:

+
   // Delegate. See the class definition above for more information. This will
   // be NULL before Init is called and after Cleanup, but is guaranteed
   // non-NULL in between.
   scoped_ptr<Delegate> delegate_;
 
   // The id of this class, given in creation and used for identifying the
   // backend when calling the delegate.
   int id_;
 
   // Directory where database files will be stored.
   FilePath history_dir_;
 
   // The history/thumbnail databases. Either MAY BE NULL if the database could
   // not be opened, all users must first check for NULL and return immediately
   // if it is. The thumbnail DB may be NULL when the history one isn't, but not
   // vice-versa.
   scoped_ptr<HistoryDatabase> db_;
   scoped_ptr<ThumbnailDatabase> thumbnail_db_;
 
   // Stores old history in a larger, slower database.
   scoped_ptr<ArchivedDatabase> archived_db_;
 
   // Full text database manager, possibly NULL if the database could not be
   // created.
   scoped_ptr<TextDatabaseManager> text_database_;
 
+  // The index used for quick history lookups.
+  scoped_ptr<history::InMemoryURLIndex> in_memory_url_index_;
+
   // Manages expiration between the various databases.
   ExpireHistoryBackend expirer_;
 
   // A commit has been scheduled to occur sometime in the future. We can check
   // non-null-ness to see if there is a commit scheduled in the future, and we
   // can use the pointer to cancel the scheduled commit. There can be only one
   // scheduled commit at a time (see ScheduleCommit).
   scoped_refptr<CommitLaterTask> scheduled_commit_;
 
   // Maps recent redirect destination pages to the chain of redirects that
@@ skipping 49 matching lines @@
   // Publishes the history to all indexers which are registered to receive
   // history data from us. Can be NULL if there are no listeners.
   scoped_ptr<HistoryPublisher> history_publisher_;
 
   DISALLOW_COPY_AND_ASSIGN(HistoryBackend);
 };
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_HISTORY_BACKEND_H_