Move instant support to SearchTabHelper.

chrome/browser/ui/search/instant_page.h

 // Copyright 2013 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.
 
 #ifndef CHROME_BROWSER_UI_SEARCH_INSTANT_PAGE_H_
 #define CHROME_BROWSER_UI_SEARCH_INSTANT_PAGE_H_
 
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/gtest_prod_util.h"
 #include "base/strings/string16.h"
+#include "chrome/browser/ui/search/search_model_observer.h"
 #include "chrome/common/instant_types.h"
 #include "chrome/common/omnibox_focus_state.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/common/page_transition_types.h"
 
 class GURL;
 
 namespace content {
 struct FrameNavigateParams;
 struct LoadCommittedDetails;
 class WebContents;
 }
 
 namespace gfx {
 class Rect;
 }
 
 // InstantPage is used to exchange messages with a page that implements the
 // Instant/Embedded Search API (http://dev.chromium.org/embeddedsearch).
 // InstantPage is not used directly but via one of its derived classes:
 // InstantOverlay, InstantNTP and InstantTab.
-class InstantPage : public content::WebContentsObserver {
+class InstantPage : public content::WebContentsObserver,
+                    public SearchModelObserver {
  public:
   // InstantPage calls its delegate in response to messages received from the
   // page. Each method is called with the |contents| corresponding to the page
   // we are observing.
   class Delegate {
    public:
     // Called when a RenderView is created, so that state can be initialized.
     virtual void InstantPageRenderViewCreated(
         const content::WebContents* contents) = 0;
 
@@ skipping 66 matching lines @@
   // Returns the Instant URL that was loaded for this page. Returns the empty
   // string if no URL was explicitly loaded as is the case for InstantTab.
   virtual const std::string& instant_url() const;
 
   // Returns true if the page is known to support the Instant API. This starts
   // out false, and is set to true whenever we get any message from the page.
   // Once true, it never becomes false (the page isn't expected to drop API
   // support suddenly).
   virtual bool supports_instant() const;
 
-  // True if Instant support has been tested and determined for this page at
-  // least once. Note that Instant support may change in the future.
-  bool instant_support_determined() const {
-    return instant_support_determined_;
-  }
-
   // Returns true if the page is the local NTP (i.e. its URL is
   // chrome::kChromeSearchLocalNTPURL).
   virtual bool IsLocal() const;
 
   // Tells the page that the user typed |text| into the omnibox. If |verbatim|
   // is false, the page predicts the query the user means to type and fetches
   // results for the prediction. If |verbatim| is true, |text| is taken as the
   // exact query (no prediction is made). |selection_start| and |selection_end|
   // mark the inline autocompleted portion (i.e., blue highlighted text). The
   // omnibox caret (cursor) is at |selection_end|.
@@ skipping 14 matching lines @@
   // by the omnibox dropdown.
   void SetPopupBounds(const gfx::Rect& bounds);
 
   // Tells the page the bounds of the omnibox (in screen coordinates). This is
   // used by the page to align text or assets properly with the omnibox.
   void SetOmniboxBounds(const gfx::Rect& bounds);
 
   // Tells the page about the font information.
   void InitializeFonts();
 
-  // Tells the renderer to determine if the page supports the Instant API, which
-  // results in a call to InstantSupportDetermined() when the reply is received.
-  void DetermineIfPageSupportsInstant();
-
   // Tells the page about the available autocomplete results.
   void SendAutocompleteResults(
       const std::vector<InstantAutocompleteResult>& results);
 
   // Tells the page that the user pressed Up or Down in the omnibox. |count| is
   // a repeat count, negative for moving up, positive for moving down.
   void UpOrDownKeyPressed(int count);
 
   // Tells the page that the user pressed Esc key in the omnibox.
   void EscKeyPressed();
@@ skipping 21 matching lines @@
   // Tells the page about new Most Visited data.
   void SendMostVisitedItems(
       const std::vector<InstantMostVisitedItem>& items);
 
   // Tells the page to toggle voice search.
   void ToggleVoiceSearch();
 
  protected:
   InstantPage(Delegate* delegate, const std::string& instant_url);
 
-  // Sets |contents| as the page to communicate with. |contents| may be NULL,
-  // which effectively stops all communication.
-  void SetContents(content::WebContents* contents);
+  // Sets |web_contents| as the page to communicate with. |web_contents| may be
+  // NULL, which effectively stops all communication.
+  void SetContents(content::WebContents* web_contents);
 
   Delegate* delegate() const { return delegate_; }
 
   // These functions are called before processing messages received from the
   // page. By default, all messages are handled, but any derived classes may
   // choose to ignore some or all of the received messages by overriding these
   // methods.
   virtual bool ShouldProcessRenderViewCreated();
   virtual bool ShouldProcessRenderViewGone();
   virtual bool ShouldProcessAboutToNavigateMainFrame();
@@ skipping 13 matching lines @@
   FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
                            DispatchRequestToUndoAllMostVisitedDeletions);
   FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
                            IgnoreMessageIfThePageIsNotActive);
   FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
                            IgnoreMessageReceivedFromThePage);
 
   // Overridden from content::WebContentsObserver:
   virtual void RenderViewCreated(
       content::RenderViewHost* render_view_host) OVERRIDE;
-  virtual void DidFinishLoad(
-      int64 frame_id,
-      const GURL& validated_url,
-      bool is_main_frame,
-      content::RenderViewHost* render_view_host) OVERRIDE;
   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
   virtual void RenderViewGone(base::TerminationStatus status) OVERRIDE;
   virtual void DidCommitProvisionalLoadForFrame(
       int64 frame_id,
       bool is_main_frame,
       const GURL& url,
       content::PageTransition transition_type,
       content::RenderViewHost* render_view_host) OVERRIDE;
   virtual void DidNavigateMainFrame(
       const content::LoadCommittedDetails& details,
       const content::FrameNavigateParams& params) OVERRIDE;
   virtual void DidFailProvisionalLoad(
       int64 frame_id,
       bool is_main_frame,
       const GURL& validated_url,
       int error_code,
       const string16& error_description,
       content::RenderViewHost* render_view_host) OVERRIDE;
 
+  // Overridden from SearchModelObserver:
+  virtual void ModelChanged(const SearchModel::State& old_state,
+                            const SearchModel::State& new_state) OVERRIDE;
+
+  // Update the status of Instant support.
+  void InstantSupportDetermined(bool supports_instant);
+
   void OnSetSuggestions(int page_id,
                         const std::vector<InstantSuggestion>& suggestions);
-  void OnInstantSupportDetermined(int page_id, bool supports_instant);
   void OnShowInstantOverlay(int page_id,
                             int height,
                             InstantSizeUnits units);
   void OnFocusOmnibox(int page_id, OmniboxFocusState state);
   void OnSearchBoxNavigate(int page_id,
                            const GURL& url,
                            content::PageTransition transition,
                            WindowOpenDisposition disposition,
                            bool is_search_type);
   void OnDeleteMostVisitedItem(int page_id, const GURL& url);
   void OnUndoMostVisitedDeletion(int page_id, const GURL& url);
   void OnUndoAllMostVisitedDeletions(int page_id);
 
+  void ClearContents();
+
   Delegate* const delegate_;
   const std::string instant_url_;
-  bool supports_instant_;
-  bool instant_support_determined_;
 
   DISALLOW_COPY_AND_ASSIGN(InstantPage);
 };
 
 #endif  // CHROME_BROWSER_UI_SEARCH_INSTANT_PAGE_H_