Move Ownership of IMUI to HistoryService.

chrome/browser/history/url_index_private_data.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_URL_INDEX_PRIVATE_DATA_H_
 #define CHROME_BROWSER_HISTORY_URL_INDEX_PRIVATE_DATA_H_
 #pragma once
 
 #include "base/file_path.h"
 #include "base/gtest_prod_util.h"
 #include "chrome/browser/history/in_memory_url_index_types.h"
 #include "chrome/browser/history/in_memory_url_index_cache.pb.h"
 
+class HistoryQuickProviderTest;
+
 namespace in_memory_url_index {
 class InMemoryURLIndexCacheItem;
 }
 
 namespace history {
 
 namespace imui = in_memory_url_index;
 
+class HistoryDatabase;
+
 // A structure describing the InMemoryURLIndex's internal data and providing for
 // restoring, rebuilding and updating that internal data.
 class URLIndexPrivateData {
  public:
   URLIndexPrivateData();
   ~URLIndexPrivateData();
 
  private:
+  friend class AddHistoryMatch;
+  friend class ::HistoryQuickProviderTest;
   friend class InMemoryURLIndex;
-  friend class AddHistoryMatch;
   friend class InMemoryURLIndexTest;
   FRIEND_TEST_ALL_PREFIXES(InMemoryURLIndexTest, CacheSaveRestore);
   FRIEND_TEST_ALL_PREFIXES(InMemoryURLIndexTest, HugeResultSet);
   FRIEND_TEST_ALL_PREFIXES(InMemoryURLIndexTest, Scoring);
   FRIEND_TEST_ALL_PREFIXES(InMemoryURLIndexTest, TitleSearch);
   FRIEND_TEST_ALL_PREFIXES(InMemoryURLIndexTest, TypedCharacterCaching);
   FRIEND_TEST_ALL_PREFIXES(InMemoryURLIndexTest, WhitelistedURLs);
   FRIEND_TEST_ALL_PREFIXES(LimitedInMemoryURLIndexTest, Initialization);
 
   // Support caching of term results so that we can optimize searches which
@@ skipping 81 matching lines @@
 
   // Sets the |languages| to a list of language encodings with which the history
   // URLs and omnibox searches are interpreted, i.e. how each is broken
   // down into words and each word is broken down into characters.
   void set_languages(const std::string& languages) { languages_ = languages; }
 
   // Restores the index's private data from the cache file stored in the
   // profile directory and returns true if successful.
   bool RestoreFromFile(const FilePath& file_path);
 
+  // Constructs a new object by rebuilding its contents from the history
+  // database in |history_db|. Returns the new URLIndexPrivateData which on
+  // success will contain the rebuilt data but upon failure will be empty.
+  static URLIndexPrivateData* RebuildFromHistory(HistoryDatabase* history_db);
+
   // Caches the index private data and writes the cache file to the profile
   // directory.
   bool SaveToFile(const FilePath& file_path);
 
-  // Reloads the history index from |history_db|.
-  bool ReloadFromHistory(URLDatabase* history_db);
-
   // Initializes all index data members in preparation for restoring the index
   // from the cache or a complete rebuild from the history database.
   void Clear();
 
   // Adds |word_id| to |history_id|'s entry in the history/word map,
   // creating a new entry if one does not already exist.
   void AddToHistoryIDWordMap(HistoryID history_id, WordID word_id);
 
   // Given a set of Char16s, finds words containing those characters.
   WordIDSet WordIDSetForTermChars(const Char16Set& term_chars);
 
   // Initializes the whitelist of URL schemes.
   static void InitializeSchemeWhitelist(std::set<std::string>* whitelist);
 
   // URL History indexing support functions.
 
-  // Indexes one URL history item.
-  void IndexRow(const URLRow& row);
+  // Indexes one URL history item as described by |row|. Returns true if the
+  // row was actually indexed.
+  bool IndexRow(const URLRow& row);
 
-  // Updates or adds an history item to the index if it meets the minimum
-  // 'quick' criteria.
-  void UpdateURL(URLID row_id, const URLRow& row);
+  // Adds the history item in |row| to the index if it does not already already
+  // exist and it meets the minimum 'quick' criteria. If the row already exists
+  // in the index then the index will be updated if the row still meets the
+  // criteria, otherwise the row will be removed from the index. Returns true
+  // if the index was actually updated.
+  bool UpdateURL(const URLRow& row);
 
-  // Deletes indexing data for an history item. The item may not have actually
-  // been indexed (which is the case if it did not previously meet minimum
-  // 'quick' criteria).
-  void DeleteURL(URLID row_id);
+  // Deletes indexing data for the history item with the URL given in |url|.
+  // The item may not have actually been indexed, which is the case if it did
+  // not previously meet minimum 'quick' criteria. Returns true if the index
+  // was actually updated.
+  bool DeleteURL(const GURL& url);
 
   // Parses and indexes the words in the URL and page title of |row|.
   void AddRowWordsToIndex(const URLRow& row);
 
   // Removes |row| and all associated words and characters from the index.
   void RemoveRowFromIndex(const URLRow& row);
 
   // Removes all words and characters associated with |row| from the index.
   void RemoveRowWordsFromIndex(const URLRow& row);
 
@@ skipping 113 matching lines @@
   // Used for unit testing only. Records the number of candidate history items
   // at three stages in the index searching process.
   size_t pre_filter_item_count_;    // After word index is queried.
   size_t post_filter_item_count_;   // After trimming large result set.
   size_t post_scoring_item_count_;  // After performing final filter/scoring.
 };
 
 }  // namespace history
 
 #endif  // CHROME_BROWSER_HISTORY_URL_INDEX_PRIVATE_DATA_H_