1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
// 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/memory/scoped_ptr.h"
#include "base/strings/string16.h"
#include "chrome/browser/ui/search/instant_ipc_sender.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,
// InstantNTP and InstantTab.
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;
// Called upon determination of Instant API support. Either in response to
// the page loading or because we received some other message.
virtual void InstantSupportDetermined(const content::WebContents* contents,
bool supports_instant) = 0;
// Called when the underlying RenderView's process crashed.
virtual void InstantPageRenderProcessGone(
const content::WebContents* contents) = 0;
// Called when the page is about to navigate to |url|.
virtual void InstantPageAboutToNavigateMainFrame(
const content::WebContents* contents,
const GURL& url) = 0;
// Called when the page wants the omnibox to be focused. |state| specifies
// the omnibox focus state.
virtual void FocusOmnibox(const content::WebContents* contents,
OmniboxFocusState state) = 0;
// Called when the page wants to navigate to |url|. Usually used by the
// page to navigate to privileged destinations (e.g. chrome:// URLs) or to
// navigate to URLs that are hidden from the page using Restricted IDs (rid
// in the API).
virtual void NavigateToURL(const content::WebContents* contents,
const GURL& url,
content::PageTransition transition,
WindowOpenDisposition disposition,
bool is_search_type) = 0;
// Called when the SearchBox wants to delete a Most Visited item.
virtual void DeleteMostVisitedItem(const GURL& url) = 0;
// Called when the SearchBox wants to undo a Most Visited deletion.
virtual void UndoMostVisitedDeletion(const GURL& url) = 0;
// Called when the SearchBox wants to undo all Most Visited deletions.
virtual void UndoAllMostVisitedDeletions() = 0;
// Called when the page fails to load for whatever reason.
virtual void InstantPageLoadFailed(content::WebContents* contents) = 0;
protected:
virtual ~Delegate();
};
virtual ~InstantPage();
// The WebContents corresponding to the page we're talking to. May be NULL.
content::WebContents* contents() const { return web_contents(); }
// Used to send IPC messages to the page.
InstantIPCSender* sender() const { return ipc_sender_.get(); }
// 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;
// Returns true if the page is the local NTP (i.e. its URL is
// chrome::kChromeSearchLocalNTPURL).
virtual bool IsLocal() const;
void InitializeFonts();
void InitializePromos();
protected:
InstantPage(Delegate* delegate, const std::string& instant_url,
bool is_incognito);
// 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 ShouldProcessAboutToNavigateMainFrame();
virtual bool ShouldProcessFocusOmnibox();
virtual bool ShouldProcessNavigateToURL();
virtual bool ShouldProcessDeleteMostVisitedItem();
virtual bool ShouldProcessUndoMostVisitedDeletion();
virtual bool ShouldProcessUndoAllMostVisitedDeletions();
private:
FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
DispatchRequestToDeleteMostVisitedItem);
FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
DispatchRequestToUndoMostVisitedDeletion);
FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
DispatchRequestToUndoAllMostVisitedDeletions);
FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
IgnoreMessageIfThePageIsNotActive);
FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
IgnoreMessageReceivedFromThePage);
FRIEND_TEST_ALL_PREFIXES(InstantPageTest,
IgnoreMessageReceivedFromIncognitoPage);
// Overridden from content::WebContentsObserver:
virtual bool OnMessageReceived(const IPC::Message& message) 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 OnFocusOmnibox(int page_id, OmniboxFocusState state);
void OnSearchBoxNavigate(int page_id,
const GURL& url,
content::PageTransition transition,
WindowOpenDisposition disposition,
bool is_search_type);
void OnCountMouseover(int page_id);
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_;
scoped_ptr<InstantIPCSender> ipc_sender_;
const std::string instant_url_;
const bool is_incognito_;
DISALLOW_COPY_AND_ASSIGN(InstantPage);
};
#endif // CHROME_BROWSER_UI_SEARCH_INSTANT_PAGE_H_
|
