OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef CHROME_BROWSER_UI_SEARCH_INSTANT_PAGE_H_ | 5 #ifndef CHROME_BROWSER_UI_SEARCH_INSTANT_TAB_H_ |
6 #define CHROME_BROWSER_UI_SEARCH_INSTANT_PAGE_H_ | 6 #define CHROME_BROWSER_UI_SEARCH_INSTANT_TAB_H_ |
7 | 7 |
8 #include "base/compiler_specific.h" | 8 #include "base/compiler_specific.h" |
9 #include "base/gtest_prod_util.h" | 9 #include "base/gtest_prod_util.h" |
10 #include "base/macros.h" | 10 #include "base/macros.h" |
11 #include "chrome/browser/ui/search/search_model_observer.h" | 11 #include "chrome/browser/ui/search/search_model_observer.h" |
12 #include "content/public/browser/web_contents_observer.h" | 12 #include "content/public/browser/web_contents_observer.h" |
13 #include "ui/base/page_transition_types.h" | 13 #include "ui/base/page_transition_types.h" |
14 | 14 |
15 class GURL; | 15 class GURL; |
16 | 16 |
17 namespace content { | 17 namespace content { |
18 class RenderFrameHost; | 18 class RenderFrameHost; |
19 class WebContents; | 19 class WebContents; |
20 } | 20 } |
21 | 21 |
22 // InstantPage is used to exchange messages with a page that implements the | 22 // InstantTab is used to exchange messages with a page that implements the |
23 // Instant/Embedded Search API (http://dev.chromium.org/embeddedsearch). | 23 // Instant/Embedded Search API (http://dev.chromium.org/embeddedsearch). |
24 class InstantPage : public content::WebContentsObserver, | 24 class InstantTab : public content::WebContentsObserver, |
25 public SearchModelObserver { | 25 public SearchModelObserver { |
26 public: | 26 public: |
27 // InstantPage calls its delegate in response to messages received from the | 27 // InstantTab calls its delegate in response to messages received from the |
28 // page. Each method is called with the |contents| corresponding to the page | 28 // page. Each method is called with the |contents| corresponding to the page |
29 // we are observing. | 29 // we are observing. |
30 class Delegate { | 30 class Delegate { |
31 public: | 31 public: |
32 // Called upon determination of Instant API support. Either in response to | 32 // Called upon determination of Instant API support. Either in response to |
33 // the page loading or because we received some other message. | 33 // the page loading or because we received some other message. |
34 virtual void InstantSupportDetermined(const content::WebContents* contents, | 34 virtual void InstantSupportDetermined(const content::WebContents* contents, |
35 bool supports_instant) = 0; | 35 bool supports_instant) = 0; |
36 | 36 |
37 // Called when the page is about to navigate to |url|. | 37 // Called when the page is about to navigate to |url|. |
38 virtual void InstantPageAboutToNavigateMainFrame( | 38 virtual void InstantTabAboutToNavigateMainFrame( |
39 const content::WebContents* contents, | 39 const content::WebContents* contents, |
40 const GURL& url) = 0; | 40 const GURL& url) = 0; |
41 | 41 |
42 protected: | 42 protected: |
43 virtual ~Delegate(); | 43 virtual ~Delegate(); |
44 }; | 44 }; |
45 | 45 |
46 explicit InstantPage(Delegate* delegate); | 46 explicit InstantTab(Delegate* delegate); |
47 | 47 |
48 ~InstantPage() override; | 48 ~InstantTab() override; |
49 | 49 |
50 // Sets |web_contents| as the page to communicate with. |web_contents| may be | 50 // Sets |web_contents| as the page to communicate with. |web_contents| may be |
51 // NULL, which effectively stops all communication. | 51 // NULL, which effectively stops all communication. |
52 void Init(content::WebContents* web_contents); | 52 void Init(content::WebContents* web_contents); |
53 | 53 |
54 // Returns true if the page is known to support the Instant API. This starts | 54 // Returns true if the page is known to support the Instant API. This starts |
55 // out false, and is set to true whenever we get any message from the page. | 55 // out false, and is set to true whenever we get any message from the page. |
56 // Once true, it never becomes false (the page isn't expected to drop API | 56 // Once true, it never becomes false (the page isn't expected to drop API |
57 // support suddenly). | 57 // support suddenly). |
58 bool supports_instant() const; | 58 bool supports_instant() const; |
59 | 59 |
60 // Returns true if the page is the local NTP (i.e. its URL is | 60 // Returns true if the page is the local NTP (i.e. its URL is |
61 // chrome::kChromeSearchLocalNTPURL). | 61 // chrome::kChromeSearchLocalNTPURL). |
62 bool IsLocal() const; | 62 bool IsLocal() const; |
63 | 63 |
64 private: | 64 private: |
65 FRIEND_TEST_ALL_PREFIXES(InstantPageTest, IsLocal); | 65 FRIEND_TEST_ALL_PREFIXES(InstantTabTest, IsLocal); |
66 FRIEND_TEST_ALL_PREFIXES(InstantPageTest, | 66 FRIEND_TEST_ALL_PREFIXES(InstantTabTest, |
67 DetermineIfPageSupportsInstant_Local); | 67 DetermineIfPageSupportsInstant_Local); |
68 FRIEND_TEST_ALL_PREFIXES(InstantPageTest, | 68 FRIEND_TEST_ALL_PREFIXES(InstantTabTest, |
69 DetermineIfPageSupportsInstant_NonLocal); | 69 DetermineIfPageSupportsInstant_NonLocal); |
70 FRIEND_TEST_ALL_PREFIXES(InstantPageTest, | 70 FRIEND_TEST_ALL_PREFIXES(InstantTabTest, |
71 PageURLDoesntBelongToInstantRenderer); | 71 PageURLDoesntBelongToInstantRenderer); |
72 FRIEND_TEST_ALL_PREFIXES(InstantPageTest, PageSupportsInstant); | 72 FRIEND_TEST_ALL_PREFIXES(InstantTabTest, PageSupportsInstant); |
73 | 73 |
74 // Overridden from content::WebContentsObserver: | 74 // Overridden from content::WebContentsObserver: |
75 void DidCommitProvisionalLoadForFrame( | 75 void DidCommitProvisionalLoadForFrame( |
76 content::RenderFrameHost* render_frame_host, | 76 content::RenderFrameHost* render_frame_host, |
77 const GURL& url, | 77 const GURL& url, |
78 ui::PageTransition transition_type) override; | 78 ui::PageTransition transition_type) override; |
79 | 79 |
80 // Overridden from SearchModelObserver: | 80 // Overridden from SearchModelObserver: |
81 void ModelChanged(const SearchModel::State& old_state, | 81 void ModelChanged(const SearchModel::State& old_state, |
82 const SearchModel::State& new_state) override; | 82 const SearchModel::State& new_state) override; |
83 | 83 |
84 // Update the status of Instant support. | 84 // Update the status of Instant support. |
85 void InstantSupportDetermined(bool supports_instant); | 85 void InstantSupportDetermined(bool supports_instant); |
86 | 86 |
87 void ClearContents(); | 87 void ClearContents(); |
88 | 88 |
89 Delegate* const delegate_; | 89 Delegate* const delegate_; |
90 | 90 |
91 DISALLOW_COPY_AND_ASSIGN(InstantPage); | 91 DISALLOW_COPY_AND_ASSIGN(InstantTab); |
92 }; | 92 }; |
93 | 93 |
94 #endif // CHROME_BROWSER_UI_SEARCH_INSTANT_PAGE_H_ | 94 #endif // CHROME_BROWSER_UI_SEARCH_INSTANT_TAB_H_ |
OLD | NEW |