1// Copyright (c) 2012 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef CHROME_BROWSER_AUTOCOMPLETE_HISTORY_QUICK_PROVIDER_H_
6#define CHROME_BROWSER_AUTOCOMPLETE_HISTORY_QUICK_PROVIDER_H_
7
8#include <string>
9
10#include "base/basictypes.h"
11#include "base/compiler_specific.h"
12#include "chrome/browser/autocomplete/history_provider.h"
13#include "chrome/browser/history/in_memory_url_index.h"
14#include "components/history/core/browser/history_types.h"
15#include "components/omnibox/autocomplete_input.h"
16#include "components/omnibox/autocomplete_match.h"
17
18class Profile;
19
20namespace history {
21class ScoredHistoryMatch;
22}  // namespace history
23
24// This class is an autocomplete provider (a pseudo-internal component of
25// the history system) which quickly (and synchronously) provides matching
26// results from recently or frequently visited sites in the profile's
27// history.
28class HistoryQuickProvider : public HistoryProvider {
29 public:
30  explicit HistoryQuickProvider(Profile* profile);
31
32  // AutocompleteProvider. |minimal_changes| is ignored since there is no asynch
33  // completion performed.
34  virtual void Start(const AutocompleteInput& input,
35                     bool minimal_changes) OVERRIDE;
36
37  // Disable this provider. For unit testing purposes only. This is required
38  // because this provider is closely associated with the HistoryURLProvider
39  // and in order to properly test the latter the HistoryQuickProvider must
40  // be disabled.
41  // TODO(mrossetti): Eliminate this once the HUP has been refactored.
42  static void set_disabled(bool disabled) { disabled_ = disabled; }
43
44 private:
45  friend class HistoryQuickProviderTest;
46  FRIEND_TEST_ALL_PREFIXES(HistoryQuickProviderTest, Spans);
47  FRIEND_TEST_ALL_PREFIXES(HistoryQuickProviderTest, Relevance);
48
49  virtual ~HistoryQuickProvider();
50
51  // Performs the autocomplete matching and scoring.
52  void DoAutocomplete();
53
54  // Creates an AutocompleteMatch from |history_match|, assigning it
55  // the score |score|.
56  AutocompleteMatch QuickMatchToACMatch(
57      const history::ScoredHistoryMatch& history_match,
58      int score);
59
60  // Returns the index that should be used for history lookups.
61  history::InMemoryURLIndex* GetIndex();
62
63  // Only for use in unittests.  Takes ownership of |index|.
64  void set_index(history::InMemoryURLIndex* index) {
65    index_for_testing_.reset(index);
66  }
67
68  AutocompleteInput autocomplete_input_;
69  std::string languages_;
70
71  // Only used for testing.
72  scoped_ptr<history::InMemoryURLIndex> index_for_testing_;
73
74  // This provider is disabled when true.
75  static bool disabled_;
76
77  DISALLOW_COPY_AND_ASSIGN(HistoryQuickProvider);
78};
79
80#endif  // CHROME_BROWSER_AUTOCOMPLETE_HISTORY_QUICK_PROVIDER_H_
81