blob: a77a474526a0440eff052d00881d093e150dcf7d [file] [log] [blame]
// 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.
#include <string>
#include "chrome/browser/autocomplete/autocomplete_input.h"
#include "chrome/browser/autocomplete/autocomplete_match.h"
#include "chrome/browser/autocomplete/autocomplete_provider.h"
#include "components/query_parser/snippet.h"
class BookmarkModel;
class Profile;
namespace bookmarks {
struct BookmarkMatch;
// This class is an autocomplete provider which quickly (and synchronously)
// provides autocomplete suggestions based on the titles of bookmarks. Page
// titles, URLs, and typed and visit counts of the bookmarks are not currently
// taken into consideration as those factors will have been used by the
// HistoryQuickProvider (HQP) while identifying suggestions.
// TODO(mrossetti): Propose a way to coordinate with the HQP the taking of typed
// and visit counts and last visit dates, etc. into consideration while scoring.
class BookmarkProvider : public AutocompleteProvider {
BookmarkProvider(AutocompleteProviderListener* listener, Profile* profile);
// When |minimal_changes| is true short circuit any additional searching and
// leave the previous matches for this provider unchanged, otherwise perform
// a complete search for |input| across all bookmark titles.
virtual void Start(const AutocompleteInput& input,
bool minimal_changes) OVERRIDE;
// Sets the BookmarkModel for unit tests.
void set_bookmark_model_for_testing(BookmarkModel* bookmark_model) {
bookmark_model_ = bookmark_model;
FRIEND_TEST_ALL_PREFIXES(BookmarkProviderTest, InlineAutocompletion);
virtual ~BookmarkProvider();
// Performs the actual matching of |input| over the bookmarks and fills in
// |matches_|.
void DoAutocomplete(const AutocompleteInput& input);
// Compose an AutocompleteMatch based on |match| that has 1) the URL of
// |match|'s bookmark, and 2) the bookmark's title, not the URL's page
// title, as the description. |input| is used to compute the match's
// inline_autocompletion. |fixed_up_input_text| is used in that way as well;
// it's passed separately so this function doesn't have to compute it.
AutocompleteMatch BookmarkMatchToACMatch(
const AutocompleteInput& input,
const base::string16& fixed_up_input_text,
const bookmarks::BookmarkMatch& match);
// Converts |positions| into ACMatchClassifications and returns the
// classifications. |text_length| is used to determine the need to add an
// 'unhighlighted' classification span so the tail of the source string
// properly highlighted.
static ACMatchClassifications ClassificationsFromMatch(
const query_parser::Snippet::MatchPositions& positions,
size_t text_length,
bool is_url);
BookmarkModel* bookmark_model_;
// True if we should use matches in the URL for scoring.
const bool score_using_url_matches_;
// Languages used during the URL formatting.
std::string languages_;