blob: 1cf9832292f41118b02a894c6c836628152ec4b6 [file] [log] [blame]
[email protected]9f4f3322012-01-18 22:29:561// Copyright (c) 2012 The Chromium Authors. All rights reserved.
license.botbf09a502008-08-24 00:55:552// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
initial.commit09911bf2008-07-26 23:55:294
[email protected]2cff0052011-03-18 16:51:445#ifndef CONTENT_RENDERER_RENDER_WIDGET_H_
6#define CONTENT_RENDERER_RENDER_WIDGET_H_
initial.commit09911bf2008-07-26 23:55:297
[email protected]aa4117f2011-12-09 22:19:218#include <deque>
[email protected]0e241b4b2012-08-18 09:06:279#include <map>
[email protected]010ea08a2009-10-11 20:21:3210
initial.commit09911bf2008-07-26 23:55:2911#include "base/basictypes.h"
[email protected]f3112a52011-09-30 23:47:4912#include "base/compiler_specific.h"
[email protected]3b63f8f42011-03-28 01:54:1513#include "base/memory/ref_counted.h"
[email protected]8704f89b2011-04-15 00:30:0514#include "base/memory/scoped_ptr.h"
15#include "base/time.h"
[email protected]350ce8702012-03-09 04:23:3816#include "base/timer.h"
[email protected]b63d58d2012-11-26 22:37:4417#include "cc/rendering_stats.h"
[email protected]f3112a52011-09-30 23:47:4918#include "content/common/content_export.h"
[email protected]921f1592011-03-18 00:41:0219#include "content/renderer/paint_aggregator.h"
[email protected]4f86bdb2012-11-10 19:11:1920#include "ipc/ipc_listener.h"
21#include "ipc/ipc_sender.h"
[email protected]debc8e52013-01-15 03:43:1222#include "third_party/WebKit/Source/Platform/chromium/public/WebRect.h"
[email protected]8bd0fe62011-01-17 06:44:3723#include "third_party/WebKit/Source/WebKit/chromium/public/WebCompositionUnderline.h"
24#include "third_party/WebKit/Source/WebKit/chromium/public/WebPopupType.h"
[email protected]8bd0fe62011-01-17 06:44:3725#include "third_party/WebKit/Source/WebKit/chromium/public/WebTextDirection.h"
[email protected]5b739cb2012-08-21 20:35:2126#include "third_party/WebKit/Source/WebKit/chromium/public/WebTextInputInfo.h"
[email protected]8bd0fe62011-01-17 06:44:3727#include "third_party/WebKit/Source/WebKit/chromium/public/WebWidgetClient.h"
[email protected]d65adb12010-04-28 17:26:4928#include "third_party/skia/include/core/SkBitmap.h"
[email protected]ad26ef42011-06-17 07:59:4529#include "ui/base/ime/text_input_type.h"
[email protected]58b48a0d2012-06-13 07:01:3530#include "ui/base/range/range.h"
[email protected]08397d52011-02-05 01:53:3831#include "ui/gfx/native_widget_types.h"
32#include "ui/gfx/rect.h"
[email protected]990278ff2012-11-13 02:12:5533#include "ui/gfx/vector2d.h"
[email protected]d353541f2012-05-03 22:45:4134#include "ui/surface/transport_dib.h"
initial.commit09911bf2008-07-26 23:55:2935#include "webkit/glue/webcursor.h"
initial.commit09911bf2008-07-26 23:55:2936
[email protected]aa4117f2011-12-09 22:19:2137struct ViewHostMsg_UpdateRect_Params;
38class ViewHostMsg_UpdateRect;
39
[email protected]484955942010-08-19 16:13:1840namespace IPC {
41class SyncMessage;
42}
43
[email protected]88efb7ec2009-07-14 16:32:5944namespace WebKit {
[email protected]41d86852012-11-07 12:23:2445class WebGestureEvent;
[email protected]0dea1652012-12-14 00:09:0946class WebInputEvent;
[email protected]e195e582013-03-08 01:32:5947class WebLayerTreeViewClient;
[email protected]6a8ddba52010-09-05 04:38:0648class WebMouseEvent;
[email protected]2d0f2e92011-10-03 09:02:2449class WebTouchEvent;
[email protected]e195e582013-03-08 01:32:5950struct WebPoint;
51struct WebRenderingStatsImpl;
[email protected]526476902011-10-06 20:34:0652}
53
[email protected]ba91a792013-02-06 09:48:2854namespace cc { class OutputSurface; }
55
[email protected]4de6d1692011-10-12 08:45:4456namespace ui {
57class Range;
58}
59
[email protected]191eb3f72010-12-21 06:27:5060namespace webkit {
61namespace npapi {
[email protected]f103ab72009-09-02 17:10:5962struct WebPluginGeometry;
[email protected]719b36f2010-12-22 20:36:4663} // namespace npapi
64
65namespace ppapi {
66class PluginInstance;
67} // namespace ppapi
68} // namespace webkit
[email protected]f103ab72009-09-02 17:10:5969
[email protected]e9ff79c2012-10-19 21:31:2670namespace content {
71struct GpuRenderingStats;
[email protected]ba91a792013-02-06 09:48:2872class RenderWidgetCompositor;
[email protected]e9ff79c2012-10-19 21:31:2673class RenderWidgetTest;
74
initial.commit09911bf2008-07-26 23:55:2975// RenderWidget provides a communication bridge between a WebWidget and
76// a RenderWidgetHost, the latter of which lives in a different process.
[email protected]f3112a52011-09-30 23:47:4977class CONTENT_EXPORT RenderWidget
[email protected]c47317e2012-06-20 22:35:3178 : public IPC::Listener,
79 public IPC::Sender,
[email protected]f3112a52011-09-30 23:47:4980 NON_EXPORTED_BASE(virtual public WebKit::WebWidgetClient),
81 public base::RefCounted<RenderWidget> {
initial.commit09911bf2008-07-26 23:55:2982 public:
83 // Creates a new RenderWidget. The opener_id is the routing ID of the
[email protected]380244092011-10-07 17:26:2784 // RenderView that this widget lives inside.
[email protected]0ebf3872008-11-07 21:35:0385 static RenderWidget* Create(int32 opener_id,
[email protected]842f10652012-06-06 01:54:0486 WebKit::WebPopupType popup_type,
87 const WebKit::WebScreenInfo& screen_info);
initial.commit09911bf2008-07-26 23:55:2988
[email protected]484955942010-08-19 16:13:1889 // Creates a WebWidget based on the popup type.
90 static WebKit::WebWidget* CreateWebWidget(RenderWidget* render_widget);
91
[email protected]c03a6e72011-04-19 21:42:0692 // The compositing surface assigned by the RenderWidgetHost
93 // (or RenderViewHost). Will be gfx::kNullPluginWindow if not assigned yet,
94 // in which case we should not create any GPU command buffers with it.
initial.commit09911bf2008-07-26 23:55:2995 // The routing ID assigned by the RenderProcess. Will be MSG_ROUTING_NONE if
96 // not yet assigned a view ID, in which case, the process MUST NOT send
97 // messages with this ID to the parent.
98 int32 routing_id() const {
99 return routing_id_;
100 }
101
[email protected]9f4f3322012-01-18 22:29:56102 int32 surface_id() const {
103 return surface_id_;
104 }
105
initial.commit09911bf2008-07-26 23:55:29106 // May return NULL when the window is closing.
[email protected]93b9d692011-04-13 00:44:31107 WebKit::WebWidget* webwidget() const { return webwidget_; }
[email protected]ee41e7d22011-10-14 19:34:09108
[email protected]93b9d692011-04-13 00:44:31109 gfx::Size size() const { return size_; }
[email protected]589621b2010-09-23 22:01:07110 bool has_focus() const { return has_focus_; }
[email protected]ee41e7d22011-10-14 19:34:09111 bool is_fullscreen() const { return is_fullscreen_; }
[email protected]204f1df2012-01-04 20:21:13112 bool is_hidden() const { return is_hidden_; }
[email protected]589621b2010-09-23 22:01:07113
[email protected]c47317e2012-06-20 22:35:31114 // IPC::Listener
[email protected]edc64de2011-11-17 20:07:38115 virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
initial.commit09911bf2008-07-26 23:55:29116
[email protected]c47317e2012-06-20 22:35:31117 // IPC::Sender
[email protected]edc64de2011-11-17 20:07:38118 virtual bool Send(IPC::Message* msg) OVERRIDE;
initial.commit09911bf2008-07-26 23:55:29119
[email protected]4873c7d2009-07-16 06:36:28120 // WebKit::WebWidgetClient
[email protected]9ed83fe2013-02-27 01:52:28121 virtual void suppressCompositorScheduling(bool enable);
[email protected]9cd43a62012-03-26 08:03:56122 virtual void willBeginCompositorFrame();
[email protected]4873c7d2009-07-16 06:36:28123 virtual void didInvalidateRect(const WebKit::WebRect&);
[email protected]990278ff2012-11-13 02:12:55124 virtual void didScrollRect(int dx, int dy,
125 const WebKit::WebRect& clipRect);
[email protected]244ac1892011-12-02 17:04:47126 virtual void didAutoResize(const WebKit::WebSize& new_size);
[email protected]91acd1c2012-03-14 08:32:39127 virtual void didActivateCompositor(int input_handler_identifier);
[email protected]ea162f92011-10-04 23:08:22128 virtual void didDeactivateCompositor();
[email protected]e195e582013-03-08 01:32:59129 virtual void initializeLayerTreeView();
[email protected]8926c602013-01-23 05:32:06130 virtual void initializeLayerTreeView(
131 WebKit::WebLayerTreeViewClient* client,
132 const WebKit::WebLayer& root_layer,
133 const WebKit::WebLayerTreeView::Settings& settings);
134 virtual WebKit::WebLayerTreeView* layerTreeView();
[email protected]3391a0772012-03-28 00:32:07135 virtual void didBecomeReadyForAdditionalInput();
[email protected]58264a32011-11-17 23:36:15136 virtual void didCommitAndDrawCompositorFrame();
137 virtual void didCompleteSwapBuffers();
[email protected]f98d7e3c2010-09-13 22:30:46138 virtual void scheduleComposite();
[email protected]5f8b1022011-01-21 23:34:50139 virtual void scheduleAnimation();
[email protected]4873c7d2009-07-16 06:36:28140 virtual void didFocus();
141 virtual void didBlur();
142 virtual void didChangeCursor(const WebKit::WebCursorInfo&);
143 virtual void closeWidgetSoon();
144 virtual void show(WebKit::WebNavigationPolicy);
145 virtual void runModal() {}
146 virtual WebKit::WebRect windowRect();
[email protected]8a9d6ca32011-06-06 20:11:30147 virtual void setToolTipText(const WebKit::WebString& text,
148 WebKit::WebTextDirection hint);
[email protected]4873c7d2009-07-16 06:36:28149 virtual void setWindowRect(const WebKit::WebRect&);
150 virtual WebKit::WebRect windowResizerRect();
151 virtual WebKit::WebRect rootWindowRect();
152 virtual WebKit::WebScreenInfo screenInfo();
[email protected]f660d9c2012-06-06 18:31:21153 virtual float deviceScaleFactor();
[email protected]fa7b1dc2010-06-23 17:53:04154 virtual void resetInputMethod();
[email protected]c68c3e4e2013-01-24 00:36:56155 virtual void didHandleGestureEvent(const WebKit::WebGestureEvent& event,
156 bool event_cancelled);
[email protected]4873c7d2009-07-16 06:36:28157
158 // Called when a plugin is moved. These events are queued up and sent with
159 // the next paint or scroll message to the host.
[email protected]191eb3f72010-12-21 06:27:50160 void SchedulePluginMove(const webkit::npapi::WebPluginGeometry& move);
initial.commit09911bf2008-07-26 23:55:29161
[email protected]268654772009-08-06 23:02:04162 // Called when a plugin window has been destroyed, to make sure the currently
163 // pending moves don't try to reference it.
164 void CleanupWindowInPluginMoves(gfx::PluginWindowHandle window);
165
[email protected]b63d58d2012-11-26 22:37:44166 // Fills in a WebRenderingStatsImpl struct containing information about
[email protected]fef5e3972012-08-07 03:59:47167 // rendering, e.g. count of frames rendered, time spent painting.
168 // This call is relatively expensive in threaded compositing mode,
169 // as it blocks on the compositor thread.
[email protected]b63d58d2012-11-26 22:37:44170 void GetRenderingStats(WebKit::WebRenderingStatsImpl&) const;
[email protected]fef5e3972012-08-07 03:59:47171
[email protected]63b465922012-09-06 02:04:52172 // Fills in a GpuRenderingStats struct containing information about
173 // GPU rendering, e.g. count of texture uploads performed, time spent
174 // uploading.
175 // This call is relatively expensive as it blocks on the GPU process
[email protected]e9ff79c2012-10-19 21:31:26176 bool GetGpuRenderingStats(GpuRenderingStats*) const;
[email protected]63b465922012-09-06 02:04:52177
[email protected]ba91a792013-02-06 09:48:28178 virtual scoped_ptr<cc::OutputSurface> CreateOutputSurface();
179
[email protected]0e241b4b2012-08-18 09:06:27180 // Callback for use with BeginSmoothScroll.
181 typedef base::Callback<void()> SmoothScrollCompletionCallback;
182
[email protected]a39ca1652012-07-13 21:30:58183 // Directs the host to begin a smooth scroll. This scroll should have the same
[email protected]0e241b4b2012-08-18 09:06:27184 // performance characteristics as a user-initiated scroll. Returns an ID of
[email protected]53beb772013-03-06 01:57:22185 // the scroll gesture. |mouse_event_x| and |mouse_event_y| are expected to be
186 // in local DIP coordinates.
[email protected]0e241b4b2012-08-18 09:06:27187 void BeginSmoothScroll(bool scroll_down,
[email protected]ebd8b562012-10-09 14:44:29188 const SmoothScrollCompletionCallback& callback,
[email protected]267909d2012-10-20 04:36:19189 int pixels_to_scroll,
[email protected]ebd8b562012-10-09 14:44:29190 int mouse_event_x,
191 int mouse_event_y);
[email protected]a39ca1652012-07-13 21:30:58192
initial.commit09911bf2008-07-26 23:55:29193 // Close the underlying WebWidget.
[email protected]60c42a8c72009-10-09 04:08:59194 virtual void Close();
initial.commit09911bf2008-07-26 23:55:29195
[email protected]6fceb912013-02-15 06:24:15196 // Notifies about a compositor frame commit operation having finished.
197 virtual void DidCommitCompositorFrame();
198
[email protected]a1127f82011-09-08 17:27:01199 float filtered_time_per_frame() const {
200 return filtered_time_per_frame_;
201 }
202
[email protected]3306f262012-09-21 19:20:42203 enum ShowIme {
204 DO_NOT_SHOW_IME,
205 SHOW_IME_IF_NEEDED
206 };
207
[email protected]35134e12013-02-22 20:07:40208 virtual void InstrumentWillBeginFrame() {}
209 virtual void InstrumentDidBeginFrame() {}
210 virtual void InstrumentDidCancelFrame() {}
211 virtual void InstrumentWillComposite() {}
212
initial.commit09911bf2008-07-26 23:55:29213 protected:
[email protected]8085dbc82008-09-26 22:53:44214 // Friend RefCounted so that the dtor can be non-public. Using this class
215 // without ref-counting is an error.
216 friend class base::RefCounted<RenderWidget>;
[email protected]7339cd22010-10-27 00:11:20217 // For unit tests.
[email protected]e9ff79c2012-10-19 21:31:26218 friend class RenderWidgetTest;
[email protected]8085dbc82008-09-26 22:53:44219
[email protected]61e2b3cc2012-03-02 16:13:34220 enum ResizeAck {
221 SEND_RESIZE_ACK,
222 NO_RESIZE_ACK,
223 };
224
[email protected]6fd35b72012-03-01 19:46:41225 RenderWidget(WebKit::WebPopupType popup_type,
[email protected]842f10652012-06-06 01:54:04226 const WebKit::WebScreenInfo& screen_info,
[email protected]14392a52012-05-02 20:28:44227 bool swapped_out);
[email protected]ce2b28e2012-08-09 15:53:57228
[email protected]8085dbc82008-09-26 22:53:44229 virtual ~RenderWidget();
initial.commit09911bf2008-07-26 23:55:29230
231 // Initializes this view with the given opener. CompleteInit must be called
232 // later.
[email protected]a635f942012-12-07 10:34:29233 bool Init(int32 opener_id);
initial.commit09911bf2008-07-26 23:55:29234
[email protected]484955942010-08-19 16:13:18235 // Called by Init and subclasses to perform initialization.
[email protected]a635f942012-12-07 10:34:29236 bool DoInit(int32 opener_id,
[email protected]484955942010-08-19 16:13:18237 WebKit::WebWidget* web_widget,
238 IPC::SyncMessage* create_widget_message);
239
initial.commit09911bf2008-07-26 23:55:29240 // Finishes creation of a pending view started with Init.
[email protected]fc4404d2012-11-07 19:53:30241 void CompleteInit();
initial.commit09911bf2008-07-26 23:55:29242
[email protected]992db4c2011-05-12 15:37:15243 // Sets whether this RenderWidget has been swapped out to be displayed by
244 // a RenderWidget in a different process. If so, no new IPC messages will be
245 // sent (only ACKs) and the process is free to exit when there are no other
246 // active RenderWidgets.
247 void SetSwappedOut(bool is_swapped_out);
248
[email protected]661eb9d2009-02-03 02:11:48249 // Paints the given rectangular region of the WebWidget into canvas (a
250 // shared memory segment returned by AllocPaintBuf on Windows). The caller
251 // must ensure that the given rect fits within the bounds of the WebWidget.
[email protected]4fb66842009-12-04 21:41:00252 void PaintRect(const gfx::Rect& rect, const gfx::Point& canvas_origin,
[email protected]9d611ca2012-11-14 13:46:56253 SkCanvas* canvas);
[email protected]4fb66842009-12-04 21:41:00254
255 // Paints a border at the given rect for debugging purposes.
[email protected]9d611ca2012-11-14 13:46:56256 void PaintDebugBorder(const gfx::Rect& rect, SkCanvas* canvas);
initial.commit09911bf2008-07-26 23:55:29257
[email protected]bd37ae252011-06-03 01:28:18258 bool IsRenderingVSynced();
[email protected]52ccd0ea2011-02-16 01:09:05259 void AnimationCallback();
260 void AnimateIfNeeded();
[email protected]65225772011-05-12 21:10:24261 void InvalidationCallback();
262 void DoDeferredUpdateAndSendInputAck();
[email protected]552e6002009-11-19 05:24:57263 void DoDeferredUpdate();
[email protected]2533ce12009-05-09 00:02:24264 void DoDeferredClose();
265 void DoDeferredSetWindowRect(const WebKit::WebRect& pos);
[email protected]ab543072013-01-25 04:38:15266 virtual void Composite();
initial.commit09911bf2008-07-26 23:55:29267
[email protected]699ab0d2009-04-23 23:19:14268 // Set the background of the render widget to a bitmap. The bitmap will be
269 // tiled in both directions if it isn't big enough to fill the area. This is
270 // mainly intended to be used in conjuction with WebView::SetIsTransparent().
271 virtual void SetBackground(const SkBitmap& bitmap);
272
[email protected]61e2b3cc2012-03-02 16:13:34273 // Resizes the render widget.
274 void Resize(const gfx::Size& new_size,
[email protected]60d47ac2013-03-01 23:42:44275 const gfx::Size& physical_backing_size,
[email protected]61e2b3cc2012-03-02 16:13:34276 const gfx::Rect& resizer_rect,
277 bool is_fullscreen,
278 ResizeAck resize_ack);
279
initial.commit09911bf2008-07-26 23:55:29280 // RenderWidget IPC message handlers
281 void OnClose();
[email protected]fc4404d2012-11-07 19:53:30282 void OnCreatingNewAck();
[email protected]30f75e62009-02-25 22:01:00283 virtual void OnResize(const gfx::Size& new_size,
[email protected]60d47ac2013-03-01 23:42:44284 const gfx::Size& physical_backing_size,
[email protected]ee41e7d22011-10-14 19:34:09285 const gfx::Rect& resizer_rect,
286 bool is_fullscreen);
[email protected]b5913d72012-02-07 22:26:54287 void OnChangeResizeRect(const gfx::Rect& resizer_rect);
[email protected]941e4552010-02-01 21:23:43288 virtual void OnWasHidden();
[email protected]9e2e4632012-07-27 16:38:41289 virtual void OnWasShown(bool needs_repainting);
[email protected]992db4c2011-05-12 15:37:15290 virtual void OnWasSwappedOut();
[email protected]53d3f302009-12-21 04:42:05291 void OnUpdateRectAck();
[email protected]8400e032010-02-26 18:50:11292 void OnCreateVideoAck(int32 video_id);
293 void OnUpdateVideoAck(int32 video_id);
[email protected]2533ce12009-05-09 00:02:24294 void OnRequestMoveAck();
[email protected]0dea1652012-12-14 00:09:09295 void OnHandleInputEvent(const WebKit::WebInputEvent* event,
296 bool keyboard_shortcut);
initial.commit09911bf2008-07-26 23:55:29297 void OnMouseCaptureLost();
[email protected]1e6e3c992010-02-08 15:52:13298 virtual void OnSetFocus(bool enable);
[email protected]fa7b1dc2010-06-23 17:53:04299 void OnSetInputMethodActive(bool is_active);
[email protected]56ea1a62011-05-30 07:05:57300 virtual void OnImeSetComposition(
[email protected]fa7b1dc2010-06-23 17:53:04301 const string16& text,
302 const std::vector<WebKit::WebCompositionUnderline>& underlines,
303 int selection_start,
304 int selection_end);
[email protected]4de6d1692011-10-12 08:45:44305 virtual void OnImeConfirmComposition(
306 const string16& text, const ui::Range& replacement_range);
[email protected]3d9ec5052013-01-02 22:05:25307 void OnPaintAtSize(const TransportDIB::Handle& dib_id,
308 int tag,
309 const gfx::Size& page_size,
310 const gfx::Size& desired_size);
311 void OnRepaint(const gfx::Size& size_to_paint);
312 void OnSmoothScrollCompleted(int gesture_id);
[email protected]4873c7d2009-07-16 06:36:28313 void OnSetTextDirection(WebKit::WebTextDirection direction);
[email protected]872ae5b2011-05-26 20:20:50314 void OnGetFPS();
[email protected]6131a642012-06-15 23:26:53315 void OnScreenInfoChanged(const WebKit::WebScreenInfo& screen_info);
[email protected]80ad8622012-11-07 16:33:03316 void OnUpdateScreenRects(const gfx::Rect& view_screen_rect,
317 const gfx::Rect& window_screen_rect);
[email protected]105dffb42013-02-20 03:46:21318#if defined(OS_ANDROID)
319 void OnImeBatchStateChanged(bool is_begin);
[email protected]2384b6c2013-02-28 23:58:51320 void OnShowImeIfNeeded();
[email protected]105dffb42013-02-20 03:46:21321#endif
initial.commit09911bf2008-07-26 23:55:29322
[email protected]97e1bf72013-03-06 14:06:05323 void AutoResizeCompositor();
324
[email protected]468ac582012-11-20 00:53:19325 virtual void SetDeviceScaleFactor(float device_scale_factor);
326
[email protected]29ed96a2012-02-04 18:12:16327 // Override points to notify derived classes that a paint has happened.
328 // WillInitiatePaint happens when we're about to generate a new bitmap and
329 // send it to the browser. DidInitiatePaint happens when that has completed,
330 // and subsequent rendering won't affect the painted content. DidFlushPaint
331 // happens once we've received the ACK that the screen has been updated.
332 // For a given paint operation, these overrides will always be called in the
333 // order WillInitiatePaint, DidInitiatePaint, DidFlushPaint.
334 virtual void WillInitiatePaint() {}
[email protected]00c39612010-03-06 02:53:28335 virtual void DidInitiatePaint() {}
336 virtual void DidFlushPaint() {}
[email protected]a2f6bc112009-06-27 16:27:25337
[email protected]65225772011-05-12 21:10:24338 // Override and return true when the widget is rendered with a graphics
[email protected]37a6f302011-07-11 23:43:08339 // context that supports asynchronous swapbuffers. When returning true, the
340 // subclass must call OnSwapBuffersPosted() when swap is posted,
341 // OnSwapBuffersComplete() when swaps complete, and OnSwapBuffersAborted if
342 // the context is lost.
[email protected]65225772011-05-12 21:10:24343 virtual bool SupportsAsynchronousSwapBuffers();
344
[email protected]479b0172012-10-29 19:27:09345 virtual bool ForceCompositingModeEnabled();
346
[email protected]65225772011-05-12 21:10:24347 // Notifies scheduler that the RenderWidget's subclass has finished or aborted
348 // a swap buffers.
[email protected]37a6f302011-07-11 23:43:08349 void OnSwapBuffersPosted();
[email protected]65225772011-05-12 21:10:24350 void OnSwapBuffersComplete();
[email protected]37a6f302011-07-11 23:43:08351 void OnSwapBuffersAborted();
[email protected]65225772011-05-12 21:10:24352
[email protected]ca4847f2010-09-24 05:39:15353 // Detects if a suitable opaque plugin covers the given paint bounds with no
354 // compositing necessary.
355 //
[email protected]719b36f2010-12-22 20:36:46356 // Returns the plugin instance that's the source of the paint if the paint
357 // can be handled by just blitting the plugin bitmap. In this case, the
358 // location, clipping, and ID of the backing store will be filled into the
359 // given output parameters.
[email protected]ca4847f2010-09-24 05:39:15360 //
[email protected]719b36f2010-12-22 20:36:46361 // A return value of null means optimized painting can not be used and we
[email protected]ca4847f2010-09-24 05:39:15362 // should continue with the normal painting code path.
[email protected]719b36f2010-12-22 20:36:46363 virtual webkit::ppapi::PluginInstance* GetBitmapForOptimizedPluginPaint(
[email protected]ca4847f2010-09-24 05:39:15364 const gfx::Rect& paint_bounds,
365 TransportDIB** dib,
366 gfx::Rect* location,
[email protected]0f3a2d12012-09-01 03:37:20367 gfx::Rect* clip,
368 float* scale_factor);
[email protected]ca4847f2010-09-24 05:39:15369
[email protected]d54169e92011-01-21 09:19:52370 // Gets the scroll offset of this widget, if this widget has a notion of
371 // scroll offset.
[email protected]ceb36f7d2012-10-31 18:33:24372 virtual gfx::Vector2d GetScrollOffset();
[email protected]d54169e92011-01-21 09:19:52373
[email protected]bee16aab2009-08-26 15:55:03374 // Sets the "hidden" state of this widget. All accesses to is_hidden_ should
375 // use this method so that we can properly inform the RenderThread of our
376 // state.
377 void SetHidden(bool hidden);
378
[email protected]2b624c562011-10-27 22:58:26379 void WillToggleFullscreen();
380 void DidToggleFullscreen();
381
[email protected]674741932009-02-04 23:44:46382 bool next_paint_is_resize_ack() const;
383 bool next_paint_is_restore_ack() const;
384 void set_next_paint_is_resize_ack();
385 void set_next_paint_is_restore_ack();
386 void set_next_paint_is_repaint_ack();
[email protected]ec7dc112008-08-06 05:30:12387
[email protected]ce2b28e2012-08-09 15:53:57388 void set_throttle_input_events(bool throttle_input_events) {
389 throttle_input_events_ = throttle_input_events;
390 }
391
[email protected]e99ef6f2011-10-16 01:13:00392 // Checks if the text input state and compose inline mode have been changed.
[email protected]fa7b1dc2010-06-23 17:53:04393 // If they are changed, the new value will be sent to the browser process.
[email protected]3306f262012-09-21 19:20:42394 // |show_ime_if_needed| should be SHOW_IME_IF_NEEDED iff the update may cause
395 // the ime to be displayed, e.g. after a tap on an input field on mobile.
396 void UpdateTextInputState(ShowIme show_ime);
[email protected]e99ef6f2011-10-16 01:13:00397
398 // Checks if the selection bounds have been changed. If they are changed,
399 // the new value will be sent to the browser process.
[email protected]58b48a0d2012-06-13 07:01:35400 virtual void UpdateSelectionBounds();
401
402 // Checks if the composition range or composition character bounds have been
403 // changed. If they are changed, the new value will be sent to the browser
404 // process.
405 virtual void UpdateCompositionInfo(
406 const ui::Range& range,
407 const std::vector<gfx::Rect>& character_bounds);
408
[email protected]56ea1a62011-05-30 07:05:57409 // Override point to obtain that the current input method state and caret
410 // position.
[email protected]ad26ef42011-06-17 07:59:45411 virtual ui::TextInputType GetTextInputType();
[email protected]3f783362011-10-21 22:40:50412 virtual void GetSelectionBounds(gfx::Rect* start, gfx::Rect* end);
[email protected]5b739cb2012-08-21 20:35:21413 virtual ui::TextInputType WebKitToUiTextInputType(
414 WebKit::WebTextInputType type);
[email protected]ad26ef42011-06-17 07:59:45415
[email protected]58b48a0d2012-06-13 07:01:35416 // Override point to obtain that the current composition character bounds.
417 // In the case of surrogate pairs, the character is treated as two characters:
418 // the bounds for first character is actual one, and the bounds for second
419 // character is zero width rectangle.
420 virtual void GetCompositionCharacterBounds(
421 std::vector<gfx::Rect>* character_bounds);
422
423 // Returns true if the composition range or composition character bounds
424 // should be sent to the browser process.
425 bool ShouldUpdateCompositionInfo(
426 const ui::Range& range,
427 const std::vector<gfx::Rect>& bounds);
428
[email protected]ad26ef42011-06-17 07:59:45429 // Override point to obtain that the current input method state about
430 // composition text.
431 virtual bool CanComposeInline();
[email protected]56ea1a62011-05-30 07:05:57432
initial.commit09911bf2008-07-26 23:55:29433 // Tells the renderer it does not have focus. Used to prevent us from getting
434 // the focus on our own when the browser did not focus us.
435 void ClearFocus();
436
[email protected]2533ce12009-05-09 00:02:24437 // Set the pending window rect.
438 // Because the real render_widget is hosted in another process, there is
439 // a time period where we may have set a new window rect which has not yet
440 // been processed by the browser. So we maintain a pending window rect
441 // size. If JS code sets the WindowRect, and then immediately calls
442 // GetWindowRect() we'll use this pending window rect as the size.
443 void SetPendingWindowRect(const WebKit::WebRect& r);
444
[email protected]446705872009-09-10 07:22:48445 // Called by OnHandleInputEvent() to notify subclasses that a key event was
446 // just handled.
447 virtual void DidHandleKeyEvent() {}
448
[email protected]67bfb83f2011-09-22 03:36:37449 // Called by OnHandleInputEvent() to notify subclasses that a mouse event is
450 // about to be handled.
451 // Returns true if no further handling is needed. In that case, the event
452 // won't be sent to WebKit or trigger DidHandleMouseEvent().
453 virtual bool WillHandleMouseEvent(const WebKit::WebMouseEvent& event);
454
[email protected]41d86852012-11-07 12:23:24455 // Called by OnHandleInputEvent() to notify subclasses that a gesture event is
456 // about to be handled.
457 // Returns true if no further handling is needed. In that case, the event
458 // won't be sent to WebKit.
459 virtual bool WillHandleGestureEvent(const WebKit::WebGestureEvent& event);
460
[email protected]6a8ddba52010-09-05 04:38:06461 // Called by OnHandleInputEvent() to notify subclasses that a mouse event was
462 // just handled.
463 virtual void DidHandleMouseEvent(const WebKit::WebMouseEvent& event) {}
464
[email protected]2d0f2e92011-10-03 09:02:24465 // Called by OnHandleInputEvent() to notify subclasses that a touch event was
466 // just handled.
467 virtual void DidHandleTouchEvent(const WebKit::WebTouchEvent& event) {}
468
[email protected]3d5c243b2012-11-30 00:26:01469 // Check whether the WebWidget has any touch event handlers registered
470 // at the given point.
471 virtual bool HasTouchEventHandlersAt(const gfx::Point& point) const;
472
initial.commit09911bf2008-07-26 23:55:29473 // Routing ID that allows us to communicate to the parent browser process
474 // RenderWidgetHost. When MSG_ROUTING_NONE, no messages may be sent.
475 int32 routing_id_;
476
[email protected]9f4f3322012-01-18 22:29:56477 int32 surface_id_;
478
[email protected]c5b3b5e2009-02-13 06:41:11479 // We are responsible for destroying this object via its Close method.
[email protected]4873c7d2009-07-16 06:36:28480 WebKit::WebWidget* webwidget_;
initial.commit09911bf2008-07-26 23:55:29481
[email protected]8926c602013-01-23 05:32:06482 // This is lazily constructed and must not outlive webwidget_.
[email protected]ba91a792013-02-06 09:48:28483 scoped_ptr<RenderWidgetCompositor> compositor_;
[email protected]8926c602013-01-23 05:32:06484
initial.commit09911bf2008-07-26 23:55:29485 // Set to the ID of the view that initiated creating this view, if any. When
486 // the view was initiated by the browser (the common case), this will be
487 // MSG_ROUTING_NONE. This is used in determining ownership when opening
488 // child tabs. See RenderWidget::createWebViewWithRequest.
489 //
490 // This ID may refer to an invalid view if that view is closed before this
491 // view is.
492 int32 opener_id_;
493
494 // The position where this view should be initially shown.
495 gfx::Rect initial_pos_;
496
[email protected]fc4404d2012-11-07 19:53:30497 bool init_complete_;
initial.commit09911bf2008-07-26 23:55:29498
499 // We store the current cursor object so we can avoid spamming SetCursor
500 // messages.
501 WebCursor current_cursor_;
[email protected]88efb7ec2009-07-14 16:32:59502
initial.commit09911bf2008-07-26 23:55:29503 // The size of the RenderWidget.
504 gfx::Size size_;
505
[email protected]b4d08452010-10-05 17:34:35506 // The TransportDIB that is being used to transfer an image to the browser.
507 TransportDIB* current_paint_buf_;
initial.commit09911bf2008-07-26 23:55:29508
[email protected]552e6002009-11-19 05:24:57509 PaintAggregator paint_aggregator_;
initial.commit09911bf2008-07-26 23:55:29510
[email protected]60d47ac2013-03-01 23:42:44511 // The size of the view's backing surface in non-DPI-adjusted pixels.
512 gfx::Size physical_backing_size_;
513
[email protected]f21c613a2009-02-12 14:46:17514 // The area that must be reserved for drawing the resize corner.
515 gfx::Rect resizer_rect_;
516
[email protected]53d3f302009-12-21 04:42:05517 // Flags for the next ViewHostMsg_UpdateRect message.
initial.commit09911bf2008-07-26 23:55:29518 int next_paint_flags_;
519
[email protected]872ae5b2011-05-26 20:20:50520 // Filtered time per frame based on UpdateRect messages.
521 float filtered_time_per_frame_;
522
[email protected]53d3f302009-12-21 04:42:05523 // True if we are expecting an UpdateRect_ACK message (i.e., that a
524 // UpdateRect message has been sent).
525 bool update_reply_pending_;
initial.commit09911bf2008-07-26 23:55:29526
[email protected]ea3ee0a2012-05-15 03:43:09527 // True if we need to send an UpdateRect message to notify the browser about
528 // an already-completed auto-resize.
529 bool need_update_rect_for_auto_resize_;
530
[email protected]65225772011-05-12 21:10:24531 // True if the underlying graphics context supports asynchronous swap.
532 // Cached on the RenderWidget because determining support is costly.
533 bool using_asynchronous_swapbuffers_;
534
535 // Number of OnSwapBuffersComplete we are expecting. Incremented each time
536 // WebWidget::composite has been been performed when the RenderWidget subclass
537 // SupportsAsynchronousSwapBuffers. Decremented in OnSwapBuffers. Will block
538 // rendering.
539 int num_swapbuffers_complete_pending_;
540
541 // When accelerated rendering is on, is the maximum number of swapbuffers that
542 // can be outstanding before we start throttling based on
543 // OnSwapBuffersComplete callback.
[email protected]82ca9b92011-09-12 23:33:07544 static const int kMaxSwapBuffersPending = 2;
[email protected]65225772011-05-12 21:10:24545
initial.commit09911bf2008-07-26 23:55:29546 // Set to true if we should ignore RenderWidget::Show calls.
547 bool did_show_;
548
549 // Indicates that we shouldn't bother generated paint events.
550 bool is_hidden_;
551
[email protected]ee41e7d22011-10-14 19:34:09552 // Indicates that we are in fullscreen mode.
553 bool is_fullscreen_;
554
initial.commit09911bf2008-07-26 23:55:29555 // Indicates that we should be repainted when restored. This flag is set to
556 // true if we receive an invalidation / scroll event from webkit while our
557 // is_hidden_ flag is set to true. This is used to force a repaint once we
558 // restore to account for the fact that our host would not know about the
559 // invalidation / scroll event(s) from webkit while we are hidden.
560 bool needs_repainting_on_restore_;
561
562 // Indicates whether we have been focused/unfocused by the browser.
563 bool has_focus_;
564
[email protected]5dd768212009-08-13 23:34:49565 // Are we currently handling an input event?
566 bool handling_input_event_;
567
[email protected]e8f775f2013-02-14 21:00:50568 // Are we currently handling an ime event?
569 bool handling_ime_event_;
570
initial.commit09911bf2008-07-26 23:55:29571 // True if we have requested this widget be closed. No more messages will
572 // be sent, except for a Close.
573 bool closing_;
574
[email protected]992db4c2011-05-12 15:37:15575 // Whether this RenderWidget is currently swapped out, such that the view is
576 // being rendered by another process. If all RenderWidgets in a process are
577 // swapped out, the process can exit.
578 bool is_swapped_out_;
579
[email protected]fa7b1dc2010-06-23 17:53:04580 // Indicates if an input method is active in the browser process.
581 bool input_method_is_active_;
initial.commit09911bf2008-07-26 23:55:29582
[email protected]5b739cb2012-08-21 20:35:21583 // Stores information about the current text input.
584 WebKit::WebTextInputInfo text_input_info_;
585
[email protected]fa7b1dc2010-06-23 17:53:04586 // Stores the current text input type of |webwidget_|.
[email protected]ad26ef42011-06-17 07:59:45587 ui::TextInputType text_input_type_;
588
589 // Stores the current type of composition text rendering of |webwidget_|.
590 bool can_compose_inline_;
[email protected]fa7b1dc2010-06-23 17:53:04591
[email protected]e99ef6f2011-10-16 01:13:00592 // Stores the current selection bounds.
[email protected]7c8873e2013-02-05 08:03:01593 gfx::Rect selection_focus_rect_;
594 gfx::Rect selection_anchor_rect_;
initial.commit09911bf2008-07-26 23:55:29595
[email protected]58b48a0d2012-06-13 07:01:35596 // Stores the current composition character bounds.
597 std::vector<gfx::Rect> composition_character_bounds_;
598
599 // Stores the current composition range.
600 ui::Range composition_range_;
601
[email protected]3e2b375b2010-04-07 17:03:12602 // The kind of popup this widget represents, NONE if not a popup.
603 WebKit::WebPopupType popup_type_;
[email protected]0ebf3872008-11-07 21:35:03604
initial.commit09911bf2008-07-26 23:55:29605 // Holds all the needed plugin window moves for a scroll.
[email protected]191eb3f72010-12-21 06:27:50606 typedef std::vector<webkit::npapi::WebPluginGeometry> WebPluginGeometryVector;
[email protected]268654772009-08-06 23:02:04607 WebPluginGeometryVector plugin_window_moves_;
initial.commit09911bf2008-07-26 23:55:29608
[email protected]699ab0d2009-04-23 23:19:14609 // A custom background for the widget.
610 SkBitmap background_;
611
[email protected]80ad8622012-11-07 16:33:03612 // While we are waiting for the browser to update window sizes, we track the
613 // pending size temporarily.
[email protected]2533ce12009-05-09 00:02:24614 int pending_window_rect_count_;
615 WebKit::WebRect pending_window_rect_;
616
[email protected]80ad8622012-11-07 16:33:03617 // The screen rects of the view and the window that contains it.
618 gfx::Rect view_screen_rect_;
619 gfx::Rect window_screen_rect_;
620
[email protected]12fbad812009-09-01 18:21:24621 scoped_ptr<IPC::Message> pending_input_event_ack_;
622
[email protected]b68a0e52011-12-08 15:11:12623 // Indicates if the next sequence of Char events should be suppressed or not.
624 bool suppress_next_char_events_;
625
[email protected]a79d8a632010-11-18 22:35:56626 // Set to true if painting to the window is handled by the accelerated
627 // compositor.
628 bool is_accelerated_compositing_active_;
[email protected]edbcde932010-05-07 17:10:46629
[email protected]350ce8702012-03-09 04:23:38630 base::OneShotTimer<RenderWidget> animation_timer_;
[email protected]5f8b1022011-01-21 23:34:50631 base::Time animation_floor_time_;
632 bool animation_update_pending_;
[email protected]65225772011-05-12 21:10:24633 bool invalidation_task_posted_;
[email protected]5f8b1022011-01-21 23:34:50634
[email protected]bd37ae252011-06-03 01:28:18635 bool has_disable_gpu_vsync_switch_;
[email protected]0fb93f52011-05-18 23:13:56636 base::TimeTicks last_do_deferred_update_time_;
637
[email protected]b63d58d2012-11-26 22:37:44638 cc::RenderingStats software_stats_;
[email protected]fef5e3972012-08-07 03:59:47639
[email protected]aa4117f2011-12-09 22:19:21640 // UpdateRect parameters for the current compositing pass. This is used to
641 // pass state between DoDeferredUpdate and OnSwapBuffersPosted.
642 scoped_ptr<ViewHostMsg_UpdateRect_Params> pending_update_params_;
643
644 // Queue of UpdateRect messages corresponding to a SwapBuffers. We want to
645 // delay sending of UpdateRect until the corresponding SwapBuffers has been
646 // executed. Since we can have several in flight, we need to keep them in a
647 // queue. Note: some SwapBuffers may not correspond to an update, in which
648 // case NULL is added to the queue.
649 std::deque<ViewHostMsg_UpdateRect*> updates_pending_swap_;
650
[email protected]842f10652012-06-06 01:54:04651 // Properties of the screen hosting this RenderWidget instance.
652 WebKit::WebScreenInfo screen_info_;
653
[email protected]f1cccb32012-06-06 18:29:59654 // The device scale factor. This value is computed from the DPI entries in
655 // |screen_info_| on some platforms, and defaults to 1 on other platforms.
[email protected]faec7b12012-06-19 14:42:13656 float device_scale_factor_;
[email protected]f1cccb32012-06-06 18:29:59657
[email protected]ce2b28e2012-08-09 15:53:57658 // Specifies whether input event throttling is enabled for this widget.
659 bool throttle_input_events_;
660
[email protected]0e241b4b2012-08-18 09:06:27661 // State associated with the BeginSmoothScroll synthetic scrolling function.
662 int next_smooth_scroll_gesture_id_;
663 typedef std::map<int, SmoothScrollCompletionCallback>
664 PendingSmoothScrollGestureMap;
665 PendingSmoothScrollGestureMap pending_smooth_scroll_gestures_;
666
[email protected]cb6430932012-10-31 00:53:36667 // Specified whether the compositor will run in its own thread.
668 bool is_threaded_compositing_enabled_;
669
[email protected]05d478752009-04-08 23:38:16670 DISALLOW_COPY_AND_ASSIGN(RenderWidget);
initial.commit09911bf2008-07-26 23:55:29671};
672
[email protected]e9ff79c2012-10-19 21:31:26673} // namespace content
674
[email protected]2cff0052011-03-18 16:51:44675#endif // CONTENT_RENDERER_RENDER_WIDGET_H_