Omnibox: Make URLs of Bookmarks Searchable

chrome/browser/bookmarks/bookmark_index.h

 // Copyright (c) 2010 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_BOOKMARKS_BOOKMARK_INDEX_H_
 #define CHROME_BROWSER_BOOKMARKS_BOOKMARK_INDEX_H_
 
 #include <map>
 #include <set>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/strings/string16.h"
+#include "components/query_parser/query_parser.h"
 
 class BookmarkNode;
-struct BookmarkTitleMatch;
+struct BookmarkMatch;
 
 namespace content {
 class BrowserContext;
 }
 
 namespace history {
 class URLDatabase;
 }
 
-namespace query_parser {
-class QueryNode;
-class QueryParser;
-}
-
-// BookmarkIndex maintains an index of the titles of bookmarks for quick
-// look up. BookmarkIndex is owned and maintained by BookmarkModel, you
+// BookmarkIndex maintains an index of the titles and URLs of bookmarks for
+// quick look up. BookmarkIndex is owned and maintained by BookmarkModel, you
 // shouldn't need to interact directly with BookmarkIndex.
 //
 // BookmarkIndex maintains the index (index_) as a map of sets. The map (type
 // Index) maps from a lower case string to the set (type NodeSet) of
-// BookmarkNodes that contain that string in their title.
+// BookmarkNodes that contain that string in their title or URL.
 class BookmarkIndex {
  public:
-  explicit BookmarkIndex(content::BrowserContext* browser_context);
+  BookmarkIndex(content::BrowserContext* browser_context,
+                const std::string& languages);

[sky, 2014/04/18 21:56:17]

Document what languages is.

[Mark P, 2014/04/18 22:22:08]

Done.

   ~BookmarkIndex();
 
   // Invoked when a bookmark has been added to the model.
   void Add(const BookmarkNode* node);
 
   // Invoked when a bookmark has been removed from the model.
   void Remove(const BookmarkNode* node);
 
-  // Returns up to |max_count| of bookmarks containing the text |query|.
-  void GetBookmarksWithTitlesMatching(
+  // Returns up to |max_count| of bookmarks containing each term from
+  // the text |query| in either the title or the URL.
+  void GetBookmarksMatching(
       const base::string16& query,
       size_t max_count,
-      std::vector<BookmarkTitleMatch>* results);
+      std::vector<BookmarkMatch>* results);
 
  private:
   typedef std::set<const BookmarkNode*> NodeSet;
   typedef std::map<base::string16, NodeSet> Index;
 
   struct Match;
   typedef std::vector<Match> Matches;
 
   // Pairs BookmarkNodes and the number of times the nodes' URLs were typed.
   // Used to sort Matches in decreasing order of typed count.
@@ skipping 17 matching lines @@
   // count so that the best matches will always be added to the results.
   static bool NodeTypedCountPairSortFunc(const NodeTypedCountPair& a,
                                          const NodeTypedCountPair& b) {
       return a.second > b.second;
   }
 
   // Add |node| to |results| if the node matches the query.
   void AddMatchToResults(
       const BookmarkNode* node,
       query_parser::QueryParser* parser,
-      const std::vector<query_parser::QueryNode*>& query_nodes,
-      std::vector<BookmarkTitleMatch>* results);
+      const query_parser::QueryNodeStarVector& query_nodes,
+      std::vector<BookmarkMatch>* results);
 
   // Populates |matches| for the specified term. If |first_term| is true, this
   // is the first term in the query. Returns true if there is at least one node
   // matching the term.
-  bool GetBookmarksWithTitleMatchingTerm(const base::string16& term,
-                                         bool first_term,
-                                         Matches* matches);
+  bool GetBookmarksMatchingTerm(const base::string16& term,
+                                bool first_term,
+                                Matches* matches);
 
   // Iterates over |matches| updating each Match's nodes to contain the
   // intersection of the Match's current nodes and the nodes at |index_i|.
   // If the intersection is empty, the Match is removed.
   //
-  // This is invoked from GetBookmarksWithTitleMatchingTerm.
+  // This is invoked from GetBookmarksMatchingTerm.
   void CombineMatchesInPlace(const Index::const_iterator& index_i,
                              Matches* matches);
 
   // Iterates over |current_matches| calculating the intersection between the
   // Match's nodes and the nodes at |index_i|. If the intersection between the
   // two is non-empty, a new match is added to |result|.
   //
   // This differs from CombineMatchesInPlace in that if the intersection is
   // non-empty the result is added to result, not combined in place. This
   // variant is used for prefix matching.
   //
-  // This is invoked from GetBookmarksWithTitleMatchingTerm.
+  // This is invoked from GetBookmarksMatchingTerm.
   void CombineMatches(const Index::const_iterator& index_i,
                       const Matches& current_matches,
                       Matches* result);
 
   // Returns the set of query words from |query|.
   std::vector<base::string16> ExtractQueryWords(const base::string16& query);
 
   // Adds |node| to |index_|.
   void RegisterNode(const base::string16& term, const BookmarkNode* node);
 
   // Removes |node| from |index_|.
   void UnregisterNode(const base::string16& term, const BookmarkNode* node);
 
   Index index_;
 
+  // True if URLs are stored in the index as well as bookmark titles.
+  const bool index_urls_;
+
   content::BrowserContext* browser_context_;
 
+  // Languages used to help parse IDNs in URLs for the bookmark index.
+  std::string languages_;
+
   DISALLOW_COPY_AND_ASSIGN(BookmarkIndex);
 };
 
 #endif  // CHROME_BROWSER_BOOKMARKS_BOOKMARK_INDEX_H_