Remove unused did_first_* fields from InternalDocumentStateData.
[chromium-blink-merge.git] / content / renderer / render_view_impl.h
blob46c94b4fe3b90745a63418bebac164d27b1c39f2
1 // Copyright (c) 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.
5 #ifndef CONTENT_RENDERER_RENDER_VIEW_IMPL_H_
6 #define CONTENT_RENDERER_RENDER_VIEW_IMPL_H_
8 #include <deque>
9 #include <map>
10 #include <set>
11 #include <string>
12 #include <vector>
14 #include "base/basictypes.h"
15 #include "base/gtest_prod_util.h"
16 #include "base/id_map.h"
17 #include "base/memory/linked_ptr.h"
18 #include "base/memory/weak_ptr.h"
19 #include "base/observer_list.h"
20 #include "base/process/process.h"
21 #include "base/strings/string16.h"
22 #include "base/timer/timer.h"
23 #include "build/build_config.h"
24 #include "cc/input/top_controls_state.h"
25 #include "cc/resources/shared_bitmap.h"
26 #include "content/common/content_export.h"
27 #include "content/common/drag_event_source_info.h"
28 #include "content/common/edit_command.h"
29 #include "content/common/frame_message_enums.h"
30 #include "content/common/gpu/client/webgraphicscontext3d_command_buffer_impl.h"
31 #include "content/common/navigation_gesture.h"
32 #include "content/common/view_message_enums.h"
33 #include "content/public/common/page_zoom.h"
34 #include "content/public/common/referrer.h"
35 #include "content/public/common/renderer_preferences.h"
36 #include "content/public/common/stop_find_action.h"
37 #include "content/public/common/top_controls_state.h"
38 #include "content/public/common/web_preferences.h"
39 #include "content/public/renderer/render_view.h"
40 #include "content/renderer/mouse_lock_dispatcher.h"
41 #include "content/renderer/render_frame_impl.h"
42 #include "content/renderer/render_widget.h"
43 #include "content/renderer/stats_collection_observer.h"
44 #include "ipc/ipc_platform_file.h"
45 #include "third_party/WebKit/public/platform/WebGraphicsContext3D.h"
46 #include "third_party/WebKit/public/platform/WebPageVisibilityState.h"
47 #include "third_party/WebKit/public/web/WebAXObject.h"
48 #include "third_party/WebKit/public/web/WebConsoleMessage.h"
49 #include "third_party/WebKit/public/web/WebDataSource.h"
50 #include "third_party/WebKit/public/web/WebElement.h"
51 #include "third_party/WebKit/public/web/WebHistoryItem.h"
52 #include "third_party/WebKit/public/web/WebIconURL.h"
53 #include "third_party/WebKit/public/web/WebInputEvent.h"
54 #include "third_party/WebKit/public/web/WebNavigationType.h"
55 #include "third_party/WebKit/public/web/WebNode.h"
56 #include "third_party/WebKit/public/web/WebPageSerializerClient.h"
57 #include "third_party/WebKit/public/web/WebSecurityOrigin.h"
58 #include "third_party/WebKit/public/web/WebViewClient.h"
59 #include "ui/base/window_open_disposition.h"
60 #include "ui/surface/transport_dib.h"
62 #if defined(OS_ANDROID)
63 #include "content/renderer/android/content_detector.h"
64 #include "content/renderer/android/renderer_date_time_picker.h"
65 #include "third_party/WebKit/public/web/WebContentDetectionResult.h"
66 #endif
68 #if defined(COMPILER_MSVC)
69 // RenderViewImpl is a diamond-shaped hierarchy, with WebWidgetClient at the
70 // root. VS warns when we inherit the WebWidgetClient method implementations
71 // from RenderWidget. It's safe to ignore that warning.
72 #pragma warning(disable: 4250)
73 #endif
75 class SkBitmap;
76 struct PP_NetAddress_Private;
77 struct ViewMsg_New_Params;
78 struct ViewMsg_Resize_Params;
79 struct ViewMsg_StopFinding_Params;
81 namespace base {
82 class CommandLine;
85 namespace blink {
86 class WebApplicationCacheHost;
87 class WebApplicationCacheHostClient;
88 class WebDOMMessageEvent;
89 class WebDataSource;
90 class WebDateTimeChooserCompletion;
91 class WebDragData;
92 class WebGestureEvent;
93 class WebIconURL;
94 class WebImage;
95 class WebPeerConnection00Handler;
96 class WebPeerConnection00HandlerClient;
97 class WebMouseEvent;
98 class WebPeerConnectionHandler;
99 class WebPeerConnectionHandlerClient;
100 class WebSpeechRecognizer;
101 class WebStorageNamespace;
102 class WebTouchEvent;
103 class WebURLRequest;
104 struct WebActiveWheelFlingParameters;
105 struct WebDateTimeChooserParams;
106 struct WebFileChooserParams;
107 struct WebFindOptions;
108 struct WebMediaPlayerAction;
109 struct WebPluginAction;
110 struct WebPoint;
111 struct WebWindowFeatures;
113 #if defined(OS_ANDROID)
114 class WebHitTestResult;
115 #endif
116 } // namespace blink
118 namespace content {
120 class HistoryController;
121 class HistoryEntry;
122 class MouseLockDispatcher;
123 class PageState;
124 class PepperPluginInstanceImpl;
125 class RenderViewImplTest;
126 class RenderViewObserver;
127 class RenderViewTest;
128 class RendererDateTimePicker;
129 class RendererWebColorChooserImpl;
130 class SpeechRecognitionDispatcher;
131 class WebPluginDelegateProxy;
132 struct DropData;
133 struct FaviconURL;
134 struct FileChooserParams;
135 struct FileChooserFileInfo;
136 struct RenderViewImplParams;
138 #if defined(OS_ANDROID)
139 class WebMediaPlayerProxyAndroid;
140 #endif
143 // RenderView is an object that manages a WebView object, and provides a
144 // communication interface with an embedding application process.
146 // DEPRECATED: RenderViewImpl is being removed as part of the SiteIsolation
147 // project. New code should be added to RenderFrameImpl instead.
149 // For context, please see https://crbug.com/467770 and
150 // http://www.chromium.org/developers/design-documents/site-isolation.
151 class CONTENT_EXPORT RenderViewImpl
152 : public RenderWidget,
153 NON_EXPORTED_BASE(public blink::WebViewClient),
154 NON_EXPORTED_BASE(public blink::WebPageSerializerClient),
155 public RenderView,
156 public base::SupportsWeakPtr<RenderViewImpl> {
157 public:
158 // Creates a new RenderView. |opener_id| is the routing ID of the RenderView
159 // responsible for creating this RenderView. Note that if the original opener
160 // has been closed, |window_was_created_with_opener| will be true and
161 // |opener_id| will be MSG_ROUTING_NONE. When |swapped_out| is true, the
162 // |proxy_routing_id| is specified, so a RenderFrameProxy can be created for
163 // this RenderView's main RenderFrame.
164 static RenderViewImpl* Create(CompositorDependencies* compositor_deps,
165 const ViewMsg_New_Params& params,
166 bool was_created_by_renderer);
168 // Used by content_layouttest_support to hook into the creation of
169 // RenderViewImpls.
170 static void InstallCreateHook(RenderViewImpl* (*create_render_view_impl)(
171 CompositorDependencies* compositor_deps,
172 const ViewMsg_New_Params&));
174 // Returns the RenderViewImpl containing the given WebView.
175 static RenderViewImpl* FromWebView(blink::WebView* webview);
177 // Returns the RenderViewImpl for the given routing ID.
178 static RenderViewImpl* FromRoutingID(int routing_id);
180 // May return NULL when the view is closing.
181 blink::WebView* webview() const;
183 const WebPreferences& webkit_preferences() const {
184 return webkit_preferences_;
187 const RendererPreferences& renderer_preferences() const {
188 return renderer_preferences_;
191 void set_send_content_state_immediately(bool value) {
192 send_content_state_immediately_ = value;
195 MouseLockDispatcher* mouse_lock_dispatcher() {
196 return mouse_lock_dispatcher_;
199 HistoryController* history_controller() {
200 return history_controller_.get();
203 // Functions to add and remove observers for this object.
204 void AddObserver(RenderViewObserver* observer);
205 void RemoveObserver(RenderViewObserver* observer);
207 // Returns the StatsCollectionObserver associated with this view, or NULL
208 // if one wasn't created;
209 StatsCollectionObserver* GetStatsCollectionObserver() {
210 return stats_collection_observer_.get();
213 // Adds the given file chooser request to the file_chooser_completion_ queue
214 // (see that var for more) and requests the chooser be displayed if there are
215 // no other waiting items in the queue.
217 // Returns true if the chooser was successfully scheduled. False means we
218 // didn't schedule anything.
219 bool ScheduleFileChooser(const FileChooserParams& params,
220 blink::WebFileChooserCompletion* completion);
222 #if defined(OS_ANDROID)
223 void DismissDateTimeDialog();
224 #endif
226 bool is_loading() const { return frames_in_progress_ != 0; }
228 void FrameDidStartLoading(blink::WebFrame* frame);
229 void FrameDidStopLoading(blink::WebFrame* frame);
231 // Sets the zoom level and notifies observers. Doesn't call zoomLevelChanged,
232 // as that is only for changes that aren't initiated by the client.
233 void SetZoomLevel(double zoom_level);
235 // Plugin-related functions --------------------------------------------------
237 #if defined(ENABLE_PLUGINS)
238 // Get/set the plugin which will be used as to handle document find requests.
239 void set_plugin_find_handler(PepperPluginInstanceImpl* plugin) {
240 plugin_find_handler_ = plugin;
242 PepperPluginInstanceImpl* plugin_find_handler() {
243 return plugin_find_handler_;
246 PepperPluginInstanceImpl* focused_pepper_plugin() {
247 return focused_pepper_plugin_;
249 PepperPluginInstanceImpl* pepper_last_mouse_event_target() {
250 return pepper_last_mouse_event_target_;
252 void set_pepper_last_mouse_event_target(PepperPluginInstanceImpl* plugin) {
253 pepper_last_mouse_event_target_ = plugin;
256 #if defined(OS_MACOSX) || defined(OS_WIN)
257 // Informs the render view that the given plugin has gained or lost focus.
258 void PluginFocusChanged(bool focused, int plugin_id);
259 #endif
261 #if defined(OS_MACOSX)
262 // Starts plugin IME.
263 void StartPluginIme();
264 #endif
266 // Indicates that the given instance has been created.
267 void PepperInstanceCreated(PepperPluginInstanceImpl* instance);
269 // Indicates that the given instance is being destroyed. This is called from
270 // the destructor, so it's important that the instance is not dereferenced
271 // from this call.
272 void PepperInstanceDeleted(PepperPluginInstanceImpl* instance);
274 // Notification that the given plugin is focused or unfocused.
275 void PepperFocusChanged(PepperPluginInstanceImpl* instance, bool focused);
277 void RegisterPluginDelegate(WebPluginDelegateProxy* delegate);
278 void UnregisterPluginDelegate(WebPluginDelegateProxy* delegate);
279 #endif // ENABLE_PLUGINS
281 void TransferActiveWheelFlingAnimation(
282 const blink::WebActiveWheelFlingParameters& params);
284 // Returns true if the focused element is editable text from the perspective
285 // of IME support (also used for on-screen keyboard). Works correctly inside
286 // supported PPAPI plugins.
287 bool HasIMETextFocus();
289 // Synchronously sends the current navigation state to the browser.
290 void SendUpdateState();
292 // Returns the length of the session history of this RenderView. Note that
293 // this only coincides with the actual length of the session history if this
294 // RenderView is the currently active RenderView of a WebContents.
295 unsigned GetLocalSessionHistoryLengthForTesting() const;
297 // Invokes OnSetFocus and marks the widget as active depending on the value
298 // of |enable|. This is used for layout tests that need to control the focus
299 // synchronously from the renderer.
300 void SetFocusAndActivateForTesting(bool enable);
302 // Change the device scale factor and force the compositor to resize.
303 void SetDeviceScaleFactorForTesting(float factor);
305 // Change the device ICC color profile while running a layout test.
306 void SetDeviceColorProfileForTesting(const std::vector<char>& color_profile);
307 void ResetDeviceColorProfileForTesting() override;
309 // Used to force the size of a window when running layout tests.
310 void ForceResizeForTesting(const gfx::Size& new_size);
312 void UseSynchronousResizeModeForTesting(bool enable);
314 // Control autoresize mode.
315 void EnableAutoResizeForTesting(const gfx::Size& min_size,
316 const gfx::Size& max_size);
317 void DisableAutoResizeForTesting(const gfx::Size& new_size);
319 // IPC::Listener implementation ----------------------------------------------
321 bool OnMessageReceived(const IPC::Message& msg) override;
323 // blink::WebWidgetClient implementation ------------------------------------
325 // Most methods are handled by RenderWidget.
326 virtual void didFocus();
327 virtual void didBlur();
328 virtual void show(blink::WebNavigationPolicy policy);
329 virtual bool requestPointerLock();
330 virtual void requestPointerUnlock();
331 virtual bool isPointerLocked();
332 virtual void didHandleGestureEvent(const blink::WebGestureEvent& event,
333 bool event_cancelled) override;
334 virtual void onMouseDown(const blink::WebNode& mouse_down_node) override;
336 virtual void initializeLayerTreeView() override;
338 // blink::WebViewClient implementation --------------------------------------
340 virtual blink::WebView* createView(blink::WebLocalFrame* creator,
341 const blink::WebURLRequest& request,
342 const blink::WebWindowFeatures& features,
343 const blink::WebString& frame_name,
344 blink::WebNavigationPolicy policy,
345 bool suppress_opener);
346 virtual blink::WebWidget* createPopupMenu(blink::WebPopupType popup_type);
347 virtual blink::WebStorageNamespace* createSessionStorageNamespace();
348 virtual void printPage(blink::WebLocalFrame* frame);
349 virtual bool enumerateChosenDirectory(
350 const blink::WebString& path,
351 blink::WebFileChooserCompletion* chooser_completion);
352 virtual void saveImageFromDataURL(const blink::WebString& data_url);
353 virtual void didCancelCompositionOnSelectionChange();
354 virtual bool handleCurrentKeyboardEvent();
355 virtual bool runFileChooser(
356 const blink::WebFileChooserParams& params,
357 blink::WebFileChooserCompletion* chooser_completion);
358 void SetValidationMessageDirection(base::string16* main_text,
359 blink::WebTextDirection main_text_hint,
360 base::string16* sub_text,
361 blink::WebTextDirection sub_text_hint);
362 virtual void showValidationMessage(const blink::WebRect& anchor_in_root_view,
363 const blink::WebString& main_text,
364 blink::WebTextDirection main_text_hint,
365 const blink::WebString& sub_text,
366 blink::WebTextDirection hint) override;
367 virtual void hideValidationMessage() override;
368 virtual void moveValidationMessage(
369 const blink::WebRect& anchor_in_root_view) override;
370 virtual void setStatusText(const blink::WebString& text);
371 virtual void setMouseOverURL(const blink::WebURL& url);
372 virtual void setKeyboardFocusURL(const blink::WebURL& url);
373 virtual void startDragging(blink::WebLocalFrame* frame,
374 const blink::WebDragData& data,
375 blink::WebDragOperationsMask mask,
376 const blink::WebImage& image,
377 const blink::WebPoint& imageOffset);
378 virtual bool acceptsLoadDrops();
379 virtual void focusNext();
380 virtual void focusPrevious();
381 virtual void focusedNodeChanged(const blink::WebNode& fromNode,
382 const blink::WebNode& toNode);
383 virtual void didUpdateLayout();
384 #if defined(OS_ANDROID) || defined(USE_AURA)
385 virtual bool didTapMultipleTargets(
386 const blink::WebSize& inner_viewport_offset,
387 const blink::WebRect& touch_rect,
388 const blink::WebVector<blink::WebRect>& target_rects);
389 #endif
390 virtual blink::WebString acceptLanguages();
391 virtual void navigateBackForwardSoon(int offset);
392 virtual int historyBackListCount();
393 virtual int historyForwardListCount();
394 virtual blink::WebSpeechRecognizer* speechRecognizer();
395 virtual void zoomLimitsChanged(double minimum_level, double maximum_level);
396 virtual void zoomLevelChanged();
397 virtual void pageScaleFactorChanged();
398 virtual double zoomLevelToZoomFactor(double zoom_level) const;
399 virtual double zoomFactorToZoomLevel(double factor) const;
400 virtual blink::WebPageVisibilityState visibilityState() const;
401 virtual void draggableRegionsChanged();
403 #if defined(OS_ANDROID)
404 virtual void scheduleContentIntent(const blink::WebURL& intent);
405 virtual void cancelScheduledContentIntents();
406 virtual blink::WebContentDetectionResult detectContentAround(
407 const blink::WebHitTestResult& touch_hit);
409 // Only used on Android since all other platforms implement
410 // date and time input fields using MULTIPLE_FIELDS_UI
411 virtual bool openDateTimeChooser(const blink::WebDateTimeChooserParams&,
412 blink::WebDateTimeChooserCompletion*);
413 virtual void didScrollWithKeyboard(const blink::WebSize& delta);
414 #endif
416 // blink::WebPageSerializerClient implementation ----------------------------
418 virtual void didSerializeDataForFrame(
419 const blink::WebURL& frame_url,
420 const blink::WebCString& data,
421 PageSerializationStatus status) override;
423 // RenderView implementation -------------------------------------------------
425 bool Send(IPC::Message* message) override;
426 RenderFrameImpl* GetMainRenderFrame() override;
427 int GetRoutingID() const override;
428 gfx::Size GetSize() const override;
429 WebPreferences& GetWebkitPreferences() override;
430 void SetWebkitPreferences(const WebPreferences& preferences) override;
431 blink::WebView* GetWebView() override;
432 bool IsEditableNode(const blink::WebNode& node) const override;
433 bool ShouldDisplayScrollbars(int width, int height) const override;
434 int GetEnabledBindings() const override;
435 bool GetContentStateImmediately() const override;
436 blink::WebPageVisibilityState GetVisibilityState() const override;
437 void DidStartLoading() override;
438 void DidStopLoading() override;
439 void Repaint(const gfx::Size& size) override;
440 void SetEditCommandForNextKeyEvent(const std::string& name,
441 const std::string& value) override;
442 void ClearEditCommands() override;
443 SSLStatus GetSSLStatusOfFrame(blink::WebFrame* frame) const override;
444 const std::string& GetAcceptLanguages() const override;
445 #if defined(OS_ANDROID)
446 void UpdateTopControlsState(TopControlsState constraints,
447 TopControlsState current,
448 bool animate) override;
449 #endif
450 bool uses_temporary_zoom_level() const { return uses_temporary_zoom_level_; }
452 // Please do not add your stuff randomly to the end here. If there is an
453 // appropriate section, add it there. If not, there are some random functions
454 // nearer to the top you can add it to.
456 protected:
457 // RenderWidget overrides:
458 void Close() override;
459 void OnResize(const ViewMsg_Resize_Params& params) override;
460 void DidInitiatePaint() override;
461 void DidFlushPaint() override;
462 gfx::Vector2d GetScrollOffset() override;
463 void DidHandleKeyEvent() override;
464 bool WillHandleMouseEvent(const blink::WebMouseEvent& event) override;
465 bool WillHandleGestureEvent(const blink::WebGestureEvent& event) override;
466 bool HasTouchEventHandlersAt(const gfx::Point& point) const override;
467 void OnSetFocus(bool enable) override;
468 void OnWasHidden() override;
469 void OnWasShown(bool needs_repainting,
470 const ui::LatencyInfo& latency_info) override;
471 GURL GetURLForGraphicsContext3D() override;
472 void OnImeSetComposition(
473 const base::string16& text,
474 const std::vector<blink::WebCompositionUnderline>& underlines,
475 int selection_start,
476 int selection_end) override;
477 void OnImeConfirmComposition(const base::string16& text,
478 const gfx::Range& replacement_range,
479 bool keep_selection) override;
480 void SetDeviceScaleFactor(float device_scale_factor) override;
481 bool SetDeviceColorProfile(const std::vector<char>& color_profile) override;
482 void OnOrientationChange() override;
483 ui::TextInputType GetTextInputType() override;
484 void GetSelectionBounds(gfx::Rect* start, gfx::Rect* end) override;
485 void FocusChangeComplete() override;
486 void GetCompositionCharacterBounds(
487 std::vector<gfx::Rect>* character_bounds) override;
488 void GetCompositionRange(gfx::Range* range) override;
489 bool CanComposeInline() override;
490 void DidCommitCompositorFrame() override;
491 void DidCompletePageScaleAnimation() override;
493 protected:
494 RenderViewImpl(CompositorDependencies* compositor_deps,
495 const ViewMsg_New_Params& params);
497 void Initialize(const ViewMsg_New_Params& params,
498 bool was_created_by_renderer);
499 void SetScreenMetricsEmulationParameters(
500 bool enabled,
501 const blink::WebDeviceEmulationParams& params) override;
503 // Do not delete directly. This class is reference counted.
504 virtual ~RenderViewImpl();
506 private:
507 // For unit tests.
508 friend class DevToolsAgentTest;
509 friend class RenderViewImplTest;
510 friend class RenderViewTest;
511 friend class RendererAccessibilityTest;
513 // TODO(nasko): Temporarily friend RenderFrameImpl, so we don't duplicate
514 // utility functions needed in both classes, while we move frame specific
515 // code away from this class.
516 friend class RenderFrameImpl;
518 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, RenderFrameMessageAfterDetach);
519 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, DecideNavigationPolicyForWebUI);
520 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest,
521 DidFailProvisionalLoadWithErrorForError);
522 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest,
523 DidFailProvisionalLoadWithErrorForCancellation);
524 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, ImeComposition);
525 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, InsertCharacters);
526 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, JSBlockSentAfterPageLoad);
527 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, LastCommittedUpdateState);
528 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, OnHandleKeyboardEvent);
529 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, OnImeTypeChanged);
530 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, OnNavStateChanged);
531 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, OnSetTextDirection);
532 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, OnUpdateWebPreferences);
533 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest,
534 SetEditableSelectionAndComposition);
535 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, StaleNavigationsIgnored);
536 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest,
537 DontIgnoreBackAfterNavEntryLimit);
538 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, UpdateTargetURLWithInvalidURL);
539 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest,
540 GetCompositionCharacterBoundsTest);
541 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, OnNavigationHttpPost);
542 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, ScreenMetricsEmulation);
543 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest,
544 DecideNavigationPolicyHandlesAllTopLevel);
545 #if defined(OS_MACOSX)
546 FRIEND_TEST_ALL_PREFIXES(RenderViewTest, MacTestCmdUp);
547 #endif
548 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, SetHistoryLengthAndOffset);
549 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, ZoomLimit);
550 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, NavigateFrame);
551 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, BasicRenderFrame);
552 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, TextInputTypeWithPepper);
553 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest,
554 MessageOrderInDidChangeSelection);
555 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, SendCandidateWindowEvents);
556 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, RenderFrameClearedAfterClose);
557 FRIEND_TEST_ALL_PREFIXES(RenderViewImplTest, PaintAfterSwapOut);
558 FRIEND_TEST_ALL_PREFIXES(SuppressErrorPageTest, Suppresses);
559 FRIEND_TEST_ALL_PREFIXES(SuppressErrorPageTest, DoesNotSuppress);
561 typedef std::map<GURL, double> HostZoomLevels;
563 enum ErrorPageType {
564 DNS_ERROR,
565 HTTP_404,
566 CONNECTION_ERROR,
569 // Old WebFrameClient implementations ----------------------------------------
571 // RenderViewImpl used to be a WebFrameClient, but now RenderFrameImpl is the
572 // WebFrameClient. However, many implementations of WebFrameClient methods
573 // still live here and are called from RenderFrameImpl. These implementations
574 // are to be moved to RenderFrameImpl <http://crbug.com/361761>.
576 void didChangeIcon(blink::WebLocalFrame*, blink::WebIconURL::Type);
577 void didUpdateCurrentHistoryItem(blink::WebLocalFrame* frame);
578 void didChangeScrollOffset(blink::WebLocalFrame* frame);
580 static Referrer GetReferrerFromRequest(
581 blink::WebFrame* frame,
582 const blink::WebURLRequest& request);
584 static WindowOpenDisposition NavigationPolicyToDisposition(
585 blink::WebNavigationPolicy policy);
587 void ApplyWebPreferencesInternal(const WebPreferences& prefs,
588 blink::WebView* web_view,
589 CompositorDependencies* compositor_deps);
591 // Sends a message and runs a nested message loop.
592 bool SendAndRunNestedMessageLoop(IPC::SyncMessage* message);
594 // IPC message handlers ------------------------------------------------------
596 // The documentation for these functions should be in
597 // content/common/*_messages.h for the message that the function is handling.
598 void OnExecuteEditCommand(const std::string& name, const std::string& value);
599 void OnMoveCaret(const gfx::Point& point);
600 void OnScrollFocusedEditableNodeIntoRect(const gfx::Rect& rect);
601 void OnSetEditCommandsForNextKeyEvent(const EditCommands& edit_commands);
602 void OnAllowBindings(int enabled_bindings_flags);
603 void OnAllowScriptToClose(bool script_can_close);
604 void OnCancelDownload(int32 download_id);
605 void OnClearFocusedElement();
606 void OnClosePage();
607 void OnClose();
609 void OnShowContextMenu(ui::MenuSourceType source_type,
610 const gfx::Point& location);
611 void OnCopyImageAt(int x, int y);
612 void OnSaveImageAt(int x, int y);
613 void OnDeterminePageLanguage();
614 void OnDisableScrollbarsForSmallWindows(
615 const gfx::Size& disable_scrollbars_size_limit);
616 void OnDragSourceEnded(const gfx::Point& client_point,
617 const gfx::Point& screen_point,
618 blink::WebDragOperation drag_operation);
619 void OnDragSourceSystemDragEnded();
620 void OnDragTargetDrop(const gfx::Point& client_pt,
621 const gfx::Point& screen_pt,
622 int key_modifiers);
623 void OnDragTargetDragEnter(const DropData& drop_data,
624 const gfx::Point& client_pt,
625 const gfx::Point& screen_pt,
626 blink::WebDragOperationsMask operations_allowed,
627 int key_modifiers);
628 void OnDragTargetDragLeave();
629 void OnDragTargetDragOver(const gfx::Point& client_pt,
630 const gfx::Point& screen_pt,
631 blink::WebDragOperationsMask operations_allowed,
632 int key_modifiers);
633 void OnEnablePreferredSizeChangedMode();
634 void OnEnableAutoResize(const gfx::Size& min_size, const gfx::Size& max_size);
635 void OnDisableAutoResize(const gfx::Size& new_size);
636 void OnEnumerateDirectoryResponse(int id,
637 const std::vector<base::FilePath>& paths);
638 void OnFileChooserResponse(
639 const std::vector<content::FileChooserFileInfo>& files);
640 void OnFind(int request_id,
641 const base::string16&,
642 const blink::WebFindOptions&);
643 void OnGetAllSavableResourceLinksForCurrentPage(const GURL& page_url);
644 void OnGetSerializedHtmlDataForCurrentPageWithLocalLinks(
645 const std::vector<GURL>& links,
646 const std::vector<base::FilePath>& local_paths,
647 const base::FilePath& local_directory_name);
648 void OnMediaPlayerActionAt(const gfx::Point& location,
649 const blink::WebMediaPlayerAction& action);
650 void OnPluginActionAt(const gfx::Point& location,
651 const blink::WebPluginAction& action);
652 void OnMoveOrResizeStarted();
653 void OnReleaseDisambiguationPopupBitmap(const cc::SharedBitmapId& id);
654 void OnResetPageEncodingToDefault();
655 void OnSetActive(bool active);
656 void OnSetBackgroundOpaque(bool opaque);
657 void OnExitFullscreen();
658 void OnSetHistoryOffsetAndLength(int history_offset, int history_length);
659 void OnSetInitialFocus(bool reverse);
660 void OnSetPageEncoding(const std::string& encoding_name);
661 void OnSetRendererPrefs(const RendererPreferences& renderer_prefs);
662 void OnSetWebUIProperty(const std::string& name, const std::string& value);
663 void OnSetZoomLevelForLoadingURL(const GURL& url, double zoom_level);
664 void OnSetZoomLevelForView(bool uses_temporary_zoom_level, double level);
665 void OnStopFinding(StopFindAction action);
666 void OnSuppressDialogsUntilSwapOut();
667 void OnThemeChanged();
668 void OnUpdateTargetURLAck();
669 void OnUpdateWebPreferences(const WebPreferences& prefs);
670 void OnResetPageScale();
671 void OnZoom(PageZoom zoom);
672 void OnEnableViewSourceMode();
673 void OnForceRedraw(int request_id);
674 void OnSelectWordAroundCaret();
675 #if defined(OS_ANDROID)
676 void OnActivateNearestFindResult(int request_id, float x, float y);
677 void OnFindMatchRects(int current_version);
678 void OnUndoScrollFocusedEditableNodeIntoRect();
679 void OnUpdateTopControlsState(bool enable_hiding,
680 bool enable_showing,
681 bool animate);
682 void OnExtractSmartClipData(const gfx::Rect& rect);
683 #elif defined(OS_MACOSX)
684 void OnGetRenderedText();
685 void OnPluginImeCompositionCompleted(const base::string16& text,
686 int plugin_id);
687 void OnSetInLiveResize(bool in_live_resize);
688 void OnSetWindowVisibility(bool visible);
689 void OnWindowFrameChanged(const gfx::Rect& window_frame,
690 const gfx::Rect& view_frame);
691 #endif
693 // Adding a new message handler? Please add it in alphabetical order above
694 // and put it in the same position in the .cc file.
696 // Misc private functions ----------------------------------------------------
697 // Check whether the preferred size has changed.
698 void CheckPreferredSize();
700 // Gets the currently focused element, if any.
701 blink::WebElement GetFocusedElement() const;
703 // Called to get the WebPlugin to handle find requests in the document.
704 // Returns NULL if there is no such WebPlugin.
705 blink::WebPlugin* GetWebPluginForFind();
707 #if defined(OS_ANDROID)
708 // Launch an Android content intent with the given URL.
709 void LaunchAndroidContentIntent(const GURL& intent_url, size_t request_id);
710 #endif
712 // Sends a reply to the current find operation handling if it was a
713 // synchronous find request.
714 void SendFindReply(int request_id,
715 int match_count,
716 int ordinal,
717 const blink::WebRect& selection_rect,
718 bool final_status_update);
720 // Starts nav_state_sync_timer_ if it isn't already running.
721 void StartNavStateSyncTimerIfNecessary();
723 #if defined(OS_WIN) || (defined(OS_POSIX) && !defined(OS_MACOSX))
724 void UpdateFontRenderingFromRendererPrefs();
725 #else
726 void UpdateFontRenderingFromRendererPrefs() {}
727 #endif
729 // Update the target url and tell the browser that the target URL has changed.
730 // If |url| is empty, show |fallback_url|.
731 void UpdateTargetURL(const GURL& url, const GURL& fallback_url);
733 // Tells the browser what the new list of favicons for the webpage is.
734 void SendUpdateFaviconURL(const std::vector<FaviconURL>& urls);
736 // Invoked from DidStopLoading(). Sends the current list of loaded favicons to
737 // the browser.
738 void DidStopLoadingIcons();
740 // Coordinate conversion -----------------------------------------------------
742 gfx::RectF ClientRectToPhysicalWindowRect(const gfx::RectF& rect) const;
744 // RenderFrameImpl accessible state ------------------------------------------
745 // The following section is the set of methods that RenderFrameImpl needs
746 // to access RenderViewImpl state. The set of state variables are page-level
747 // specific, so they don't belong in RenderFrameImpl and should remain in
748 // this object.
749 base::ObserverList<RenderViewObserver>& observers() { return observers_; }
751 // TODO(nasko): Remove this method when we move to frame proxy objects, since
752 // the concept of swapped out will be eliminated.
753 void set_is_swapped_out(bool swapped_out) {
754 is_swapped_out_ = swapped_out;
757 NavigationGesture navigation_gesture() {
758 return navigation_gesture_;
760 void set_navigation_gesture(NavigationGesture gesture) {
761 navigation_gesture_ = gesture;
764 // Platform specific theme preferences if any are updated here.
765 #if defined(OS_WIN)
766 void UpdateThemePrefs();
767 #else
768 void UpdateThemePrefs() {}
769 #endif
771 // ---------------------------------------------------------------------------
772 // ADDING NEW FUNCTIONS? Please keep private functions alphabetized and put
773 // it in the same order in the .cc file as it was in the header.
774 // ---------------------------------------------------------------------------
776 // Settings ------------------------------------------------------------------
778 WebPreferences webkit_preferences_;
779 RendererPreferences renderer_preferences_;
781 HostZoomLevels host_zoom_levels_;
783 // Whether content state (such as form state, scroll position and page
784 // contents) should be sent to the browser immediately. This is normally
785 // false, but set to true by some tests.
786 bool send_content_state_immediately_;
788 // Bitwise-ORed set of extra bindings that have been enabled. See
789 // BindingsPolicy for details.
790 int enabled_bindings_;
792 // If true, we send IPC messages when |preferred_size_| changes.
793 bool send_preferred_size_changes_;
795 // If non-empty, and |send_preferred_size_changes_| is true, disable drawing
796 // scroll bars on windows smaller than this size. Used for windows that the
797 // browser resizes to the size of the content, such as browser action popups.
798 // If a render view is set to the minimum size of its content, webkit may add
799 // scroll bars. This makes sense for fixed sized windows, but it does not
800 // make sense when the size of the view was chosen to fit the content.
801 // This setting ensures that no scroll bars are drawn. The size limit exists
802 // because if the view grows beyond a size known to the browser, scroll bars
803 // should be drawn.
804 gfx::Size disable_scrollbars_size_limit_;
806 // Loading state -------------------------------------------------------------
808 // The gesture that initiated the current navigation.
809 // TODO(nasko): Move to RenderFrame, as this is per-frame state.
810 NavigationGesture navigation_gesture_;
812 // Used for popups.
813 bool opened_by_user_gesture_;
815 // Whether this RenderView was created by a frame that was suppressing its
816 // opener. If so, we may want to load pages in a separate process. See
817 // decidePolicyForNavigation for details.
818 bool opener_suppressed_;
820 // Whether we must stop creating nested message loops for modal dialogs until
821 // OnSwapOut is called. This is necessary because modal dialogs have a
822 // PageGroupLoadDeferrer on the stack that interferes with swapping out.
823 bool suppress_dialogs_until_swap_out_;
825 // Timer used to delay the updating of nav state (see
826 // StartNavStateSyncTimerIfNecessary).
827 base::OneShotTimer<RenderViewImpl> nav_state_sync_timer_;
829 // Page IDs ------------------------------------------------------------------
830 // See documentation in RenderView.
831 int32 page_id_;
833 // The next available page ID to use for this RenderView. These IDs are
834 // specific to a given RenderView and the frames within it.
835 int32 next_page_id_;
837 // The offset of the current item in the history list.
838 int history_list_offset_;
840 // The RenderView's current impression of the history length. This includes
841 // any items that have committed in this process, but because of cross-process
842 // navigations, the history may have some entries that were committed in other
843 // processes. We won't know about them until the next navigation in this
844 // process.
845 int history_list_length_;
847 // Counter to track how many frames have sent start notifications but not stop
848 // notifications. TODO(avi): Remove this once DidStartLoading/DidStopLoading
849 // are gone.
850 int frames_in_progress_;
852 // UI state ------------------------------------------------------------------
854 // The state of our target_url transmissions. When we receive a request to
855 // send a URL to the browser, we set this to TARGET_INFLIGHT until an ACK
856 // comes back - if a new request comes in before the ACK, we store the new
857 // URL in pending_target_url_ and set the status to TARGET_PENDING. If an
858 // ACK comes back and we are in TARGET_PENDING, we send the stored URL and
859 // revert to TARGET_INFLIGHT.
861 // We don't need a queue of URLs to send, as only the latest is useful.
862 enum {
863 TARGET_NONE,
864 TARGET_INFLIGHT, // We have a request in-flight, waiting for an ACK
865 TARGET_PENDING // INFLIGHT + we have a URL waiting to be sent
866 } target_url_status_;
868 // The URL we show the user in the status bar. We use this to determine if we
869 // want to send a new one (we do not need to send duplicates). It will be
870 // equal to either |mouse_over_url_| or |focus_url_|, depending on which was
871 // updated last.
872 GURL target_url_;
874 // The URL the user's mouse is hovering over.
875 GURL mouse_over_url_;
877 // The URL that has keyboard focus.
878 GURL focus_url_;
880 // The next target URL we want to send to the browser.
881 GURL pending_target_url_;
883 // Indicates whether this view overrides url-based zoom settings.
884 bool uses_temporary_zoom_level_;
886 #if defined(OS_ANDROID)
887 // Cache the old top controls state constraints. Used when updating
888 // current value only without altering the constraints.
889 TopControlsState top_controls_constraints_;
890 #endif
892 // View ----------------------------------------------------------------------
894 // Cache the preferred size of the page in order to prevent sending the IPC
895 // when layout() recomputes but doesn't actually change sizes.
896 gfx::Size preferred_size_;
898 // Used to delay determining the preferred size (to avoid intermediate
899 // states for the sizes).
900 base::OneShotTimer<RenderViewImpl> check_preferred_size_timer_;
902 // Bookkeeping to suppress redundant scroll and focus requests for an already
903 // scrolled and focused editable node.
904 bool has_scrolled_focused_editable_node_into_rect_;
905 gfx::Rect rect_for_scrolled_focused_editable_node_;
907 // Helper objects ------------------------------------------------------------
909 RenderFrameImpl* main_render_frame_;
911 // The next group of objects all implement RenderViewObserver, so are deleted
912 // along with the RenderView automatically. This is why we just store
913 // weak references.
915 // The speech recognition dispatcher attached to this view, lazily
916 // initialized.
917 SpeechRecognitionDispatcher* speech_recognition_dispatcher_;
919 // Mouse Lock dispatcher attached to this view.
920 MouseLockDispatcher* mouse_lock_dispatcher_;
922 scoped_ptr<HistoryController> history_controller_;
924 #if defined(OS_ANDROID)
925 // Android Specific ---------------------------------------------------------
927 // Expected id of the next content intent launched. Used to prevent scheduled
928 // intents to be launched if aborted.
929 size_t expected_content_intent_id_;
931 // List of click-based content detectors.
932 typedef std::vector< linked_ptr<ContentDetector> > ContentDetectorList;
933 ContentDetectorList content_detectors_;
935 // A date/time picker object for date and time related input elements.
936 scoped_ptr<RendererDateTimePicker> date_time_picker_client_;
937 #endif
939 // Plugins -------------------------------------------------------------------
941 // All the currently active plugin delegates for this RenderView; kept so
942 // that we can enumerate them to send updates about things like window
943 // location or tab focus and visibily. These are non-owning references.
944 std::set<WebPluginDelegateProxy*> plugin_delegates_;
946 #if defined(OS_WIN)
947 // The ID of the focused NPAPI plugin.
948 int focused_plugin_id_;
949 #endif
951 #if defined(ENABLE_PLUGINS)
952 PepperPluginInstanceImpl* plugin_find_handler_;
954 typedef std::set<PepperPluginInstanceImpl*> PepperPluginSet;
955 PepperPluginSet active_pepper_instances_;
957 // TODO(jam): these belong on RenderFrame, once the browser knows which frame
958 // is focused and sends the IPCs which use these to the correct frame. Until
959 // then, we must store these on RenderView as that's the one place that knows
960 // about all the RenderFrames for a page.
962 // Whether or not the focus is on a PPAPI plugin
963 PepperPluginInstanceImpl* focused_pepper_plugin_;
965 // The plugin instance that received the last mouse event. It is set to NULL
966 // if the last mouse event went to elements other than Pepper plugins.
967 // |pepper_last_mouse_event_target_| is not owned by this class. We depend on
968 // the RenderFrameImpl to NULL it out when it destructs.
969 PepperPluginInstanceImpl* pepper_last_mouse_event_target_;
970 #endif
972 // Misc ----------------------------------------------------------------------
974 // The current and pending file chooser completion objects. If the queue is
975 // nonempty, the first item represents the currently running file chooser
976 // callback, and the remaining elements are the other file chooser completion
977 // still waiting to be run (in order).
978 struct PendingFileChooser;
979 std::deque< linked_ptr<PendingFileChooser> > file_chooser_completions_;
981 // The current directory enumeration callback
982 std::map<int, blink::WebFileChooserCompletion*> enumeration_completions_;
983 int enumeration_completion_id_;
985 // The SessionStorage namespace that we're assigned to has an ID, and that ID
986 // is passed to us upon creation. WebKit asks for this ID upon first use and
987 // uses it whenever asking the browser process to allocate new storage areas.
988 int64 session_storage_namespace_id_;
990 // Stores edit commands associated to the next key event.
991 // Shall be cleared as soon as the next key event is processed.
992 EditCommands edit_commands_;
994 // All the registered observers. We expect this list to be small, so vector
995 // is fine.
996 base::ObserverList<RenderViewObserver> observers_;
998 // Wraps the |webwidget_| as a MouseLockDispatcher::LockTarget interface.
999 scoped_ptr<MouseLockDispatcher::LockTarget> webwidget_mouse_lock_target_;
1001 // This field stores drag/drop related info for the event that is currently
1002 // being handled. If the current event results in starting a drag/drop
1003 // session, this info is sent to the browser along with other drag/drop info.
1004 DragEventSourceInfo possible_drag_event_info_;
1006 // NOTE: stats_collection_observer_ should be the last members because their
1007 // constructors call the AddObservers method of RenderViewImpl.
1008 scoped_ptr<StatsCollectionObserver> stats_collection_observer_;
1010 typedef std::map<cc::SharedBitmapId, cc::SharedBitmap*> BitmapMap;
1011 BitmapMap disambiguation_bitmaps_;
1013 bool page_scale_factor_is_one_;
1015 // ---------------------------------------------------------------------------
1016 // ADDING NEW DATA? Please see if it fits appropriately in one of the above
1017 // sections rather than throwing it randomly at the end. If you're adding a
1018 // bunch of stuff, you should probably create a helper class and put your
1019 // data and methods on that to avoid bloating RenderView more. You can
1020 // use the Observer interface to filter IPC messages and receive frame change
1021 // notifications.
1022 // ---------------------------------------------------------------------------
1024 DISALLOW_COPY_AND_ASSIGN(RenderViewImpl);
1027 } // namespace content
1029 #endif // CONTENT_RENDERER_RENDER_VIEW_IMPL_H_