15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_AUTOCOMPLETE_HISTORY_QUICK_PROVIDER_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_AUTOCOMPLETE_HISTORY_QUICK_PROVIDER_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/autocomplete/history_provider.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/history/in_memory_url_index.h" 141320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "components/history/core/browser/history_types.h" 155f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "components/omnibox/autocomplete_input.h" 165f1c94371a64b3196d4be9466099bb892df9b88eTorne (Richard Coles)#include "components/omnibox/autocomplete_match.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Profile; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace history { 21f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)class ScoredHistoryMatch; 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace history 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class is an autocomplete provider (a pseudo-internal component of 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// the history system) which quickly (and synchronously) provides matching 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// results from recently or frequently visited sites in the profile's 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// history. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class HistoryQuickProvider : public HistoryProvider { 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 30116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch explicit HistoryQuickProvider(Profile* profile); 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // AutocompleteProvider. |minimal_changes| is ignored since there is no asynch 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // completion performed. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Start(const AutocompleteInput& input, 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool minimal_changes) OVERRIDE; 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Disable this provider. For unit testing purposes only. This is required 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // because this provider is closely associated with the HistoryURLProvider 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and in order to properly test the latter the HistoryQuickProvider must 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // be disabled. 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // TODO(mrossetti): Eliminate this once the HUP has been refactored. 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void set_disabled(bool disabled) { disabled_ = disabled; } 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class HistoryQuickProviderTest; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(HistoryQuickProviderTest, Spans); 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(HistoryQuickProviderTest, Relevance); 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~HistoryQuickProvider(); 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Performs the autocomplete matching and scoring. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DoAutocomplete(); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates an AutocompleteMatch from |history_match|, assigning it 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the score |score|. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AutocompleteMatch QuickMatchToACMatch( 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const history::ScoredHistoryMatch& history_match, 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int score); 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the index that should be used for history lookups. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) history::InMemoryURLIndex* GetIndex(); 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Only for use in unittests. Takes ownership of |index|. 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_index(history::InMemoryURLIndex* index) { 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) index_for_testing_.reset(index); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AutocompleteInput autocomplete_input_; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string languages_; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Only used for testing. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<history::InMemoryURLIndex> index_for_testing_; 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This provider is disabled when true. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool disabled_; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(HistoryQuickProvider); 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_AUTOCOMPLETE_HISTORY_QUICK_PROVIDER_H_ 81