src/chrome/browser/ui/search/instant_controller.h

   1 // Copyright 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_UI_SEARCH_INSTANT_CONTROLLER_H_
   6 #define CHROME_BROWSER_UI_SEARCH_INSTANT_CONTROLLER_H_
   7
   8 #include <list>
   9 #include <string>
  10 #include <utility>
  11 #include <vector>
  12
  13 #include "base/basictypes.h"
  14 #include "base/gtest_prod_util.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "base/strings/string16.h"
  17 #include "chrome/browser/ui/search/instant_page.h"
  18 #include "chrome/common/instant_types.h"
  19 #include "chrome/common/omnibox_focus_state.h"
  20 #include "chrome/common/search_types.h"
  21 #include "ui/gfx/native_widget_types.h"
  22 #include "ui/gfx/rect.h"
  23
  24 class BrowserInstantController;
  25 class GURL;
  26 class InstantService;
  27 class InstantTab;
  28 class Profile;
  29
  30 namespace content {
  31 class WebContents;
  32 }
  33
  34 namespace gfx {
  35 class Rect;
  36 }
  37
  38 // Macro used for logging debug events. |message| should be a std::string.
  39 #define LOG_INSTANT_DEBUG_EVENT(controller, message) \
  40     controller->LogDebugEvent(message)
  41
  42 // InstantController drives Chrome Instant, i.e., the browser implementation of
  43 // the Embedded Search API (see http://dev.chromium.org/embeddedsearch).
  44 //
  45 // In extended mode, InstantController maintains and coordinates an InstantTab
  46 // instance of InstantPage. An InstantTab instance points to the currently
  47 // active tab, if it supports the Embedded Search API. InstantTab is backed by a
  48 // WebContents and it does not own that WebContents.
  49 //
  50 // InstantController is owned by Browser via BrowserInstantController.
  51 class InstantController : public InstantPage::Delegate {
  52  public:
  53   explicit InstantController(BrowserInstantController* browser);
  54   virtual ~InstantController();
  55
  56   // Sets the stored start-edge margin and width of the omnibox.
  57   void SetOmniboxBounds(const gfx::Rect& bounds);
  58
  59   // Sends the current SearchProvider suggestion to the Instant page if any.
  60   void SetSuggestionToPrefetch(const InstantSuggestion& suggestion);
  61
  62   // Notifies |instant_Tab_| to toggle voice search.
  63   void ToggleVoiceSearch();
  64
  65   // Called if the browser is navigating to a search URL for |search_terms| with
  66   // search-term-replacement enabled. If |instant_tab_| can be used to process
  67   // the search, this does so and returns true. Else, returns false.
  68   bool SubmitQuery(const string16& search_terms);
  69
  70   // Called to indicate that the omnibox focus state changed with the given
  71   // |reason|. If |focus_state| is FOCUS_NONE, |view_gaining_focus| is set to
  72   // the view gaining focus.
  73   void OmniboxFocusChanged(OmniboxFocusState focus_state,
  74                            OmniboxFocusChangeReason reason,
  75                            gfx::NativeView view_gaining_focus);
  76
  77   // The search mode in the active tab has changed. Bind |instant_tab_| if the
  78   // |new_mode| reflects an Instant search results page.
  79   void SearchModeChanged(const SearchMode& old_mode,
  80                          const SearchMode& new_mode);
  81
  82   // The user switched tabs. Bind |instant_tab_| if the newly active tab is an
  83   // Instant search results page.
  84   void ActiveTabChanged();
  85
  86   // The user is about to switch tabs.
  87   void TabDeactivated(content::WebContents* contents);
  88
  89   // Adds a new event to |debug_events_| and also DVLOG's it. Ensures that
  90   // |debug_events_| doesn't get too large.
  91   void LogDebugEvent(const std::string& info) const;
  92
  93   // Resets list of debug events.
  94   void ClearDebugEvents();
  95
  96   // See comments for |debug_events_| below.
  97   const std::list<std::pair<int64, std::string> >& debug_events() {
  98     return debug_events_;
  99   }
 100
 101   // Gets the stored start-edge margin and width of the omnibox.
 102   const gfx::Rect omnibox_bounds() {
 103     return omnibox_bounds_;
 104   }
 105
 106   // Used by BrowserInstantController to notify InstantController about the
 107   // instant support change event for the active web contents.
 108   void InstantSupportChanged(InstantSupportState instant_support);
 109
 110  protected:
 111   // Accessors are made protected for testing purposes.
 112   virtual InstantTab* instant_tab() const;
 113
 114   virtual Profile* profile() const;
 115
 116  private:
 117   friend class InstantExtendedManualTest;
 118   friend class InstantTestBase;
 119
 120   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, ExtendedModeIsOn);
 121   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, MostVisited);
 122   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, NTPIsPreloaded);
 123   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, PreloadedNTPIsUsedInNewTab);
 124   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, PreloadedNTPIsUsedInSameTab);
 125   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, PreloadedNTPForWrongProvider);
 126   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, PreloadedNTPRenderProcessGone);
 127   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest,
 128                            PreloadedNTPDoesntSupportInstant);
 129   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, ProcessIsolation);
 130   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, UnrelatedSiteInstance);
 131   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, OnDefaultSearchProviderChanged);
 132   FRIEND_TEST_ALL_PREFIXES(InstantExtendedNetworkTest,
 133                            NTPReactsToNetworkChanges);
 134   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest,
 135                            AcceptingURLSearchDoesNotNavigate);
 136   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, AcceptingJSSearchDoesNotRunJS);
 137   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest,
 138                            ReloadSearchAfterBackReloadsCorrectQuery);
 139   FRIEND_TEST_ALL_PREFIXES(InstantExtendedFirstTabTest,
 140                            RedirectToLocalOnLoadFailure);
 141   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, KeyboardTogglesVoiceSearch);
 142   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, HomeButtonAffectsMargin);
 143   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest, SearchReusesInstantTab);
 144   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest,
 145                            SearchDoesntReuseInstantTabWithoutSupport);
 146   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest,
 147                            TypedSearchURLDoesntReuseInstantTab);
 148   FRIEND_TEST_ALL_PREFIXES(InstantExtendedTest,
 149                            DispatchMVChangeEventWhileNavigatingBackToNTP);
 150
 151   // Overridden from InstantPage::Delegate:
 152   // TODO(shishir): We assume that the WebContent's current RenderViewHost is
 153   // the RenderViewHost being created which is not always true. Fix this.
 154   virtual void InstantSupportDetermined(
 155       const content::WebContents* contents,
 156       bool supports_instant) OVERRIDE;
 157   virtual void InstantPageAboutToNavigateMainFrame(
 158       const content::WebContents* contents,
 159       const GURL& url) OVERRIDE;
 160   virtual void InstantPageLoadFailed(content::WebContents* contents) OVERRIDE;
 161
 162   // Helper function to navigate the given contents to the local fallback
 163   // Instant URL and trim the history correctly.
 164   void RedirectToLocalNTP(content::WebContents* contents);
 165
 166   // Helper for OmniboxFocusChanged. Commit or discard the overlay.
 167   void OmniboxLostFocus(gfx::NativeView view_gaining_focus);
 168
 169   // If the active tab is an Instant search results page, sets |instant_tab_| to
 170   // point to it. Else, deletes any existing |instant_tab_|.
 171   void ResetInstantTab();
 172
 173   // Sends theme info, omnibox bounds, etc. down to the Instant tab.
 174   void UpdateInfoForInstantTab();
 175
 176   // Returns whether input is in progress, i.e. if the omnibox has focus and the
 177   // active tab is in mode SEARCH_SUGGESTIONS.
 178   bool IsInputInProgress() const;
 179
 180   // Returns the InstantService for the browser profile.
 181   InstantService* GetInstantService() const;
 182
 183   BrowserInstantController* const browser_;
 184
 185   // The instance of InstantPage maintained by InstantController.
 186   scoped_ptr<InstantTab> instant_tab_;
 187
 188   // Omnibox focus state.
 189   OmniboxFocusState omnibox_focus_state_;
 190
 191   // The reason for the most recent omnibox focus change.
 192   OmniboxFocusChangeReason omnibox_focus_change_reason_;
 193
 194   // The search model mode for the active tab.
 195   SearchMode search_mode_;
 196
 197   // The start-edge margin and width of the omnibox, used by the page to align
 198   // its suggestions with the omnibox.
 199   gfx::Rect omnibox_bounds_;
 200
 201   // List of events and their timestamps, useful in debugging Instant behaviour.
 202   mutable std::list<std::pair<int64, std::string> > debug_events_;
 203
 204   DISALLOW_COPY_AND_ASSIGN(InstantController);
 205 };
 206
 207 #endif  // CHROME_BROWSER_UI_SEARCH_INSTANT_CONTROLLER_H_