chrome/browser/autocomplete/history_quick_provider.h

   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/autocomplete_input.h"
  13 #include "chrome/browser/autocomplete/autocomplete_match.h"
  14 #include "chrome/browser/autocomplete/history_provider.h"
  15 #include "chrome/browser/history/history_types.h"
  16 #include "chrome/browser/history/in_memory_url_index.h"
  17
  18 class Profile;
  19
  20 namespace history {
  21 class 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.
  28 class HistoryQuickProvider : public HistoryProvider {
  29  public:
  30   HistoryQuickProvider(AutocompleteProviderListener* listener,
  31                        Profile* profile);
  32
  33   // AutocompleteProvider. |minimal_changes| is ignored since there is no asynch
  34   // completion performed.
  35   virtual void Start(const AutocompleteInput& input,
  36                      bool minimal_changes) OVERRIDE;
  37
  38   virtual void DeleteMatch(const AutocompleteMatch& match) OVERRIDE;
  39
  40   // Disable this provider. For unit testing purposes only. This is required
  41   // because this provider is closely associated with the HistoryURLProvider
  42   // and in order to properly test the latter the HistoryQuickProvider must
  43   // be disabled.
  44   // TODO(mrossetti): Eliminate this once the HUP has been refactored.
  45   static void set_disabled(bool disabled) { disabled_ = disabled; }
  46
  47  private:
  48   friend class HistoryQuickProviderTest;
  49   FRIEND_TEST_ALL_PREFIXES(HistoryQuickProviderTest, Spans);
  50   FRIEND_TEST_ALL_PREFIXES(HistoryQuickProviderTest, Relevance);
  51
  52   virtual ~HistoryQuickProvider();
  53
  54   // Performs the autocomplete matching and scoring.
  55   void DoAutocomplete();
  56
  57   // Creates an AutocompleteMatch from |history_match|, assigning it
  58   // the score |score|.
  59   AutocompleteMatch QuickMatchToACMatch(
  60       const history::ScoredHistoryMatch& history_match,
  61       int score);
  62
  63   // Returns the index that should be used for history lookups.
  64   history::InMemoryURLIndex* GetIndex();
  65
  66   // Only for use in unittests.  Takes ownership of |index|.
  67   void set_index(history::InMemoryURLIndex* index) {
  68     index_for_testing_.reset(index);
  69   }
  70
  71   AutocompleteInput autocomplete_input_;
  72   std::string languages_;
  73
  74   // Only used for testing.
  75   scoped_ptr<history::InMemoryURLIndex> index_for_testing_;
  76
  77   // This provider is disabled when true.
  78   static bool disabled_;
  79
  80   DISALLOW_COPY_AND_ASSIGN(HistoryQuickProvider);
  81 };
  82
  83 #endif  // CHROME_BROWSER_AUTOCOMPLETE_HISTORY_QUICK_PROVIDER_H_