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
|
// Copyright (c) 2010 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_INSTANT_INSTANT_LOADER_H_
#define CHROME_BROWSER_INSTANT_INSTANT_LOADER_H_
#pragma once
#include "base/basictypes.h"
#include "base/scoped_ptr.h"
#include "base/string16.h"
#include "base/timer.h"
#include "chrome/browser/instant/instant_commit_type.h"
#include "chrome/browser/search_engines/template_url_id.h"
#include "chrome/common/notification_observer.h"
#include "chrome/common/notification_registrar.h"
#include "chrome/common/page_transition_types.h"
#include "googleurl/src/gurl.h"
#include "ui/gfx/rect.h"
class InstantLoaderDelegate;
class InstantLoaderManagerTest;
class TabContents;
class TabContentsWrapper;
class TemplateURL;
// InstantLoader does the loading of a particular URL for InstantController.
// InstantLoader notifies its delegate, which is typically InstantController, of
// all interesting events.
//
// InstantLoader is created with a TemplateURLID. If non-zero InstantLoader
// first determines if the site actually supports instant. If it doesn't, the
// delegate is notified by way of |InstantLoaderDoesntSupportInstant|.
//
// If the TemplateURLID supplied to the constructor is zero, then the url is
// loaded as is.
class InstantLoader : public NotificationObserver {
public:
InstantLoader(InstantLoaderDelegate* delegate, TemplateURLID id);
virtual ~InstantLoader();
// Invoked to load a URL. |tab_contents| is the TabContents the preview is
// going to be shown on top of and potentially replace.
void Update(TabContentsWrapper* tab_contents,
const TemplateURL* template_url,
const GURL& url,
PageTransition::Type transition_type,
const string16& user_text,
bool verbatim,
string16* suggested_text);
// Sets the bounds of the omnibox (in screen coordinates). The bounds are
// remembered until the preview is committed or destroyed. This is only used
// when showing results for a search provider that supports instant.
void SetOmniboxBounds(const gfx::Rect& bounds);
// Returns true if the mouse is down as the result of activating the preview
// content.
bool IsMouseDownFromActivate();
// Releases the preview TabContents passing ownership to the caller. This is
// intended to be called when the preview TabContents is committed. This does
// not notify the delegate.
TabContentsWrapper* ReleasePreviewContents(InstantCommitType type);
// Calls through to method of same name on delegate.
bool ShouldCommitInstantOnMouseUp();
void CommitInstantLoader();
virtual void Observe(NotificationType type,
const NotificationSource& source,
const NotificationDetails& details);
// The preview TabContents; may be null.
TabContentsWrapper* preview_contents() const {
return preview_contents_.get();
}
// Returns true if the preview TabContents is ready to be shown.
bool ready() const { return ready_; }
const GURL& url() const { return url_; }
bool verbatim() const { return verbatim_; }
// Are we showing instant results?
bool is_showing_instant() const { return template_url_id_ != 0; }
// If we're showing instant this returns non-zero.
TemplateURLID template_url_id() const { return template_url_id_; }
// See description above field.
const string16& user_text() const { return user_text_; }
private:
friend class InstantLoaderManagerTest;
friend class InstantTest;
class FrameLoadObserver;
class PaintObserverImpl;
class TabContentsDelegateImpl;
// Invoked when the page wants to update the suggested text. If |user_text_|
// starts with |suggested_text|, then the delegate is notified of the change,
// which results in updating the omnibox.
void SetCompleteSuggestedText(const string16& suggested_text);
// Invoked when the page paints.
void PreviewPainted();
// Invoked to show the preview. This is invoked in two possible cases: when
// the renderer paints, or when an auth dialog is shown. This notifies the
// delegate the preview is ready to be shown.
void ShowPreview();
// Invoked once the page has finished loading and the script has been sent.
void PageFinishedLoading();
// Returns the bounds of the omnibox in terms of the preview tab contents.
gfx::Rect GetOmniboxBoundsInTermsOfPreview();
// Are we waiting for the preview page to finish loading?
bool is_waiting_for_load() const {
return frame_load_observer_.get() != NULL;
}
// Invoked if it the page doesn't really support instant when we thought it
// did. If |needs_reload| is true, the text changed since the first load and
// the page needs to be reloaded.
void PageDoesntSupportInstant(bool needs_reload);
// Invokes |SetBoundsToPage(false)|. This is called from the timer.
void ProcessBoundsChange();
// Notifes the page of the omnibox bounds. If |force_if_loading| is true the
// bounds are sent down even if we're waiting on the load, otherwise if we're
// waiting on the load and |force_if_loading| is false this does nothing.
void SendBoundsToPage(bool force_if_loading);
// Creates and sets the preview TabContentsWrapper.
void CreatePreviewContents(TabContentsWrapper* tab_contents);
InstantLoaderDelegate* delegate_;
// If we're showing instant results this is the ID of the TemplateURL driving
// the results. A value of 0 means there is no TemplateURL.
const TemplateURLID template_url_id_;
// The url we're displaying.
GURL url_;
// Delegate of the preview TabContents. Used to detect when the user does some
// gesture on the TabContents and the preview needs to be activated.
scoped_ptr<TabContentsDelegateImpl> preview_tab_contents_delegate_;
// The preview TabContents; may be null.
scoped_ptr<TabContentsWrapper> preview_contents_;
// Is the preview_contents ready to be shown?
bool ready_;
// The text the user typed in the omnibox, stripped of the leading ?, if any.
string16 user_text_;
// The latest suggestion from the page.
string16 complete_suggested_text_;
// The latest suggestion (suggested text less the user text).
string16 last_suggestion_;
// See description above setter.
gfx::Rect omnibox_bounds_;
// Last bounds passed to the page.
gfx::Rect last_omnibox_bounds_;
scoped_ptr<FrameLoadObserver> frame_load_observer_;
// Transition type of the match last passed to Update.
PageTransition::Type last_transition_type_;
// Timer used to update the bounds of the omnibox.
base::OneShotTimer<InstantLoader> update_bounds_timer_;
// Used to get notifications about renderers coming and going.
NotificationRegistrar registrar_;
// Last value of verbatim passed to |Update|.
bool verbatim_;
DISALLOW_COPY_AND_ASSIGN(InstantLoader);
};
#endif // CHROME_BROWSER_INSTANT_INSTANT_LOADER_H_
|
