blob: 68da32c24f2045c84e8e272a0586ce63266e3652 [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"
[email protected]ed7defa2013-03-12 21:29:5915#include "base/memory/weak_ptr.h"
[email protected]8704f89b2011-04-15 00:30:0516#include "base/time.h"
[email protected]350ce8702012-03-09 04:23:3817#include "base/timer.h"
[email protected]6e84de22013-03-18 06:54:2718#include "cc/debug/rendering_stats.h"
[email protected]f3112a52011-09-30 23:47:4919#include "content/common/content_export.h"
[email protected]ed7defa2013-03-12 21:29:5920#include "content/common/gpu/client/webgraphicscontext3d_command_buffer_impl.h"
[email protected]921f1592011-03-18 00:41:0221#include "content/renderer/paint_aggregator.h"
[email protected]4f86bdb2012-11-10 19:11:1922#include "ipc/ipc_listener.h"
23#include "ipc/ipc_sender.h"
[email protected]debc8e52013-01-15 03:43:1224#include "third_party/WebKit/Source/Platform/chromium/public/WebRect.h"
[email protected]8bd0fe62011-01-17 06:44:3725#include "third_party/WebKit/Source/WebKit/chromium/public/WebCompositionUnderline.h"
26#include "third_party/WebKit/Source/WebKit/chromium/public/WebPopupType.h"
[email protected]8bd0fe62011-01-17 06:44:3727#include "third_party/WebKit/Source/WebKit/chromium/public/WebTextDirection.h"
[email protected]5b739cb2012-08-21 20:35:2128#include "third_party/WebKit/Source/WebKit/chromium/public/WebTextInputInfo.h"
[email protected]8bd0fe62011-01-17 06:44:3729#include "third_party/WebKit/Source/WebKit/chromium/public/WebWidgetClient.h"
[email protected]d65adb12010-04-28 17:26:4930#include "third_party/skia/include/core/SkBitmap.h"
[email protected]ad26ef42011-06-17 07:59:4531#include "ui/base/ime/text_input_type.h"
[email protected]58b48a0d2012-06-13 07:01:3532#include "ui/base/range/range.h"
[email protected]08397d52011-02-05 01:53:3833#include "ui/gfx/native_widget_types.h"
34#include "ui/gfx/rect.h"
[email protected]990278ff2012-11-13 02:12:5535#include "ui/gfx/vector2d.h"
[email protected]d353541f2012-05-03 22:45:4136#include "ui/surface/transport_dib.h"
initial.commit09911bf2008-07-26 23:55:2937#include "webkit/glue/webcursor.h"
initial.commit09911bf2008-07-26 23:55:2938
[email protected]aa4117f2011-12-09 22:19:2139struct ViewHostMsg_UpdateRect_Params;
40class ViewHostMsg_UpdateRect;
41
[email protected]484955942010-08-19 16:13:1842namespace IPC {
43class SyncMessage;
44}
45
[email protected]88efb7ec2009-07-14 16:32:5946namespace WebKit {
[email protected]41d86852012-11-07 12:23:2447class WebGestureEvent;
[email protected]0dea1652012-12-14 00:09:0948class WebInputEvent;
[email protected]6a8ddba52010-09-05 04:38:0649class WebMouseEvent;
[email protected]2d0f2e92011-10-03 09:02:2450class WebTouchEvent;
[email protected]e195e582013-03-08 01:32:5951struct WebPoint;
52struct WebRenderingStatsImpl;
[email protected]526476902011-10-06 20:34:0653}
54
[email protected]ba91a792013-02-06 09:48:2855namespace cc { class OutputSurface; }
56
[email protected]4de6d1692011-10-12 08:45:4457namespace ui {
58class Range;
59}
60
[email protected]191eb3f72010-12-21 06:27:5061namespace webkit {
62namespace npapi {
[email protected]f103ab72009-09-02 17:10:5963struct WebPluginGeometry;
[email protected]719b36f2010-12-22 20:36:4664} // namespace npapi
65
66namespace ppapi {
67class PluginInstance;
68} // namespace ppapi
69} // namespace webkit
[email protected]f103ab72009-09-02 17:10:5970
[email protected]e9ff79c2012-10-19 21:31:2671namespace content {
72struct GpuRenderingStats;
[email protected]ba91a792013-02-06 09:48:2873class RenderWidgetCompositor;
[email protected]e9ff79c2012-10-19 21:31:2674class RenderWidgetTest;
75
initial.commit09911bf2008-07-26 23:55:2976// RenderWidget provides a communication bridge between a WebWidget and
77// a RenderWidgetHost, the latter of which lives in a different process.
[email protected]f3112a52011-09-30 23:47:4978class CONTENT_EXPORT RenderWidget
[email protected]c47317e2012-06-20 22:35:3179 : public IPC::Listener,
80 public IPC::Sender,
[email protected]f3112a52011-09-30 23:47:4981 NON_EXPORTED_BASE(virtual public WebKit::WebWidgetClient),
[email protected]ed7defa2013-03-12 21:29:5982 NON_EXPORTED_BASE(public WebGraphicsContext3DSwapBuffersClient),
[email protected]f3112a52011-09-30 23:47:4983 public base::RefCounted<RenderWidget> {
initial.commit09911bf2008-07-26 23:55:2984 public:
85 // Creates a new RenderWidget. The opener_id is the routing ID of the
[email protected]380244092011-10-07 17:26:2786 // RenderView that this widget lives inside.
[email protected]0ebf3872008-11-07 21:35:0387 static RenderWidget* Create(int32 opener_id,
[email protected]842f10652012-06-06 01:54:0488 WebKit::WebPopupType popup_type,
89 const WebKit::WebScreenInfo& screen_info);
initial.commit09911bf2008-07-26 23:55:2990
[email protected]484955942010-08-19 16:13:1891 // Creates a WebWidget based on the popup type.
92 static WebKit::WebWidget* CreateWebWidget(RenderWidget* render_widget);
93
[email protected]c03a6e72011-04-19 21:42:0694 // The compositing surface assigned by the RenderWidgetHost
95 // (or RenderViewHost). Will be gfx::kNullPluginWindow if not assigned yet,
96 // in which case we should not create any GPU command buffers with it.
initial.commit09911bf2008-07-26 23:55:2997 // The routing ID assigned by the RenderProcess. Will be MSG_ROUTING_NONE if
98 // not yet assigned a view ID, in which case, the process MUST NOT send
99 // messages with this ID to the parent.
100 int32 routing_id() const {
101 return routing_id_;
102 }
103
[email protected]9f4f3322012-01-18 22:29:56104 int32 surface_id() const {
105 return surface_id_;
106 }
107
initial.commit09911bf2008-07-26 23:55:29108 // May return NULL when the window is closing.
[email protected]93b9d692011-04-13 00:44:31109 WebKit::WebWidget* webwidget() const { return webwidget_; }
[email protected]ee41e7d22011-10-14 19:34:09110
[email protected]93b9d692011-04-13 00:44:31111 gfx::Size size() const { return size_; }
[email protected]589621b2010-09-23 22:01:07112 bool has_focus() const { return has_focus_; }
[email protected]ee41e7d22011-10-14 19:34:09113 bool is_fullscreen() const { return is_fullscreen_; }
[email protected]204f1df2012-01-04 20:21:13114 bool is_hidden() const { return is_hidden_; }
[email protected]589621b2010-09-23 22:01:07115
[email protected]c47317e2012-06-20 22:35:31116 // IPC::Listener
[email protected]edc64de2011-11-17 20:07:38117 virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
initial.commit09911bf2008-07-26 23:55:29118
[email protected]c47317e2012-06-20 22:35:31119 // IPC::Sender
[email protected]edc64de2011-11-17 20:07:38120 virtual bool Send(IPC::Message* msg) OVERRIDE;
initial.commit09911bf2008-07-26 23:55:29121
[email protected]4873c7d2009-07-16 06:36:28122 // WebKit::WebWidgetClient
[email protected]9ed83fe2013-02-27 01:52:28123 virtual void suppressCompositorScheduling(bool enable);
[email protected]9cd43a62012-03-26 08:03:56124 virtual void willBeginCompositorFrame();
[email protected]4873c7d2009-07-16 06:36:28125 virtual void didInvalidateRect(const WebKit::WebRect&);
[email protected]990278ff2012-11-13 02:12:55126 virtual void didScrollRect(int dx, int dy,
127 const WebKit::WebRect& clipRect);
[email protected]244ac1892011-12-02 17:04:47128 virtual void didAutoResize(const WebKit::WebSize& new_size);
[email protected]91acd1c2012-03-14 08:32:39129 virtual void didActivateCompositor(int input_handler_identifier);
[email protected]ea162f92011-10-04 23:08:22130 virtual void didDeactivateCompositor();
[email protected]e195e582013-03-08 01:32:59131 virtual void initializeLayerTreeView();
[email protected]8926c602013-01-23 05:32:06132 virtual WebKit::WebLayerTreeView* layerTreeView();
[email protected]3391a0772012-03-28 00:32:07133 virtual void didBecomeReadyForAdditionalInput();
[email protected]58264a32011-11-17 23:36:15134 virtual void didCommitAndDrawCompositorFrame();
135 virtual void didCompleteSwapBuffers();
[email protected]f98d7e3c2010-09-13 22:30:46136 virtual void scheduleComposite();
[email protected]5f8b1022011-01-21 23:34:50137 virtual void scheduleAnimation();
[email protected]4873c7d2009-07-16 06:36:28138 virtual void didFocus();
139 virtual void didBlur();
140 virtual void didChangeCursor(const WebKit::WebCursorInfo&);
141 virtual void closeWidgetSoon();
142 virtual void show(WebKit::WebNavigationPolicy);
143 virtual void runModal() {}
144 virtual WebKit::WebRect windowRect();
[email protected]8a9d6ca32011-06-06 20:11:30145 virtual void setToolTipText(const WebKit::WebString& text,
146 WebKit::WebTextDirection hint);
[email protected]4873c7d2009-07-16 06:36:28147 virtual void setWindowRect(const WebKit::WebRect&);
148 virtual WebKit::WebRect windowResizerRect();
149 virtual WebKit::WebRect rootWindowRect();
150 virtual WebKit::WebScreenInfo screenInfo();
[email protected]f660d9c2012-06-06 18:31:21151 virtual float deviceScaleFactor();
[email protected]fa7b1dc2010-06-23 17:53:04152 virtual void resetInputMethod();
[email protected]c68c3e4e2013-01-24 00:36:56153 virtual void didHandleGestureEvent(const WebKit::WebGestureEvent& event,
154 bool event_cancelled);
[email protected]4873c7d2009-07-16 06:36:28155
156 // Called when a plugin is moved. These events are queued up and sent with
157 // the next paint or scroll message to the host.
[email protected]191eb3f72010-12-21 06:27:50158 void SchedulePluginMove(const webkit::npapi::WebPluginGeometry& move);
initial.commit09911bf2008-07-26 23:55:29159
[email protected]268654772009-08-06 23:02:04160 // Called when a plugin window has been destroyed, to make sure the currently
161 // pending moves don't try to reference it.
162 void CleanupWindowInPluginMoves(gfx::PluginWindowHandle window);
163
[email protected]b63d58d2012-11-26 22:37:44164 // Fills in a WebRenderingStatsImpl struct containing information about
[email protected]fef5e3972012-08-07 03:59:47165 // rendering, e.g. count of frames rendered, time spent painting.
[email protected]b63d58d2012-11-26 22:37:44166 void GetRenderingStats(WebKit::WebRenderingStatsImpl&) const;
[email protected]fef5e3972012-08-07 03:59:47167
[email protected]63b465922012-09-06 02:04:52168 // Fills in a GpuRenderingStats struct containing information about
169 // GPU rendering, e.g. count of texture uploads performed, time spent
170 // uploading.
171 // This call is relatively expensive as it blocks on the GPU process
[email protected]e9ff79c2012-10-19 21:31:26172 bool GetGpuRenderingStats(GpuRenderingStats*) const;
[email protected]63b465922012-09-06 02:04:52173
[email protected]24ed0432013-04-24 07:50:31174 RenderWidgetCompositor* compositor() const;
175
[email protected]ba91a792013-02-06 09:48:28176 virtual scoped_ptr<cc::OutputSurface> CreateOutputSurface();
177
[email protected]0e241b4b2012-08-18 09:06:27178 // Callback for use with BeginSmoothScroll.
179 typedef base::Callback<void()> SmoothScrollCompletionCallback;
180
[email protected]a39ca1652012-07-13 21:30:58181 // Directs the host to begin a smooth scroll. This scroll should have the same
[email protected]0e241b4b2012-08-18 09:06:27182 // performance characteristics as a user-initiated scroll. Returns an ID of
[email protected]53beb772013-03-06 01:57:22183 // the scroll gesture. |mouse_event_x| and |mouse_event_y| are expected to be
184 // in local DIP coordinates.
[email protected]0c2ebef2013-04-03 12:14:10185 void BeginSmoothScroll(bool scroll_down,
[email protected]ebd8b562012-10-09 14:44:29186 const SmoothScrollCompletionCallback& callback,
[email protected]267909d2012-10-20 04:36:19187 int pixels_to_scroll,
[email protected]ebd8b562012-10-09 14:44:29188 int mouse_event_x,
189 int mouse_event_y);
[email protected]a39ca1652012-07-13 21:30:58190
initial.commit09911bf2008-07-26 23:55:29191 // Close the underlying WebWidget.
[email protected]60c42a8c72009-10-09 04:08:59192 virtual void Close();
initial.commit09911bf2008-07-26 23:55:29193
[email protected]6fceb912013-02-15 06:24:15194 // Notifies about a compositor frame commit operation having finished.
195 virtual void DidCommitCompositorFrame();
196
[email protected]a1127f82011-09-08 17:27:01197 float filtered_time_per_frame() const {
198 return filtered_time_per_frame_;
199 }
200
[email protected]3306f262012-09-21 19:20:42201 enum ShowIme {
202 DO_NOT_SHOW_IME,
203 SHOW_IME_IF_NEEDED
204 };
205
[email protected]35134e12013-02-22 20:07:40206 virtual void InstrumentWillBeginFrame() {}
207 virtual void InstrumentDidBeginFrame() {}
208 virtual void InstrumentDidCancelFrame() {}
209 virtual void InstrumentWillComposite() {}
210
[email protected]34bb3ac2013-03-08 02:41:28211 virtual bool AllowPartialSwap() const;
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]f0c2a242013-03-15 19:34:52266 virtual void Composite(base::TimeTicks frame_begin_time);
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]d9083762013-03-24 01:36:40276 float overdraw_bottom_height,
[email protected]61e2b3cc2012-03-02 16:13:34277 const gfx::Rect& resizer_rect,
278 bool is_fullscreen,
279 ResizeAck resize_ack);
280
initial.commit09911bf2008-07-26 23:55:29281 // RenderWidget IPC message handlers
[email protected]c084330e02013-04-27 01:08:15282 void OnHandleInputEvent(const WebKit::WebInputEvent* event,
283 bool keyboard_shortcut);
284 void OnMouseCaptureLost();
285 virtual void OnSetFocus(bool enable);
initial.commit09911bf2008-07-26 23:55:29286 void OnClose();
[email protected]fc4404d2012-11-07 19:53:30287 void OnCreatingNewAck();
[email protected]30f75e62009-02-25 22:01:00288 virtual void OnResize(const gfx::Size& new_size,
[email protected]60d47ac2013-03-01 23:42:44289 const gfx::Size& physical_backing_size,
[email protected]d9083762013-03-24 01:36:40290 float overdraw_bottom_height,
[email protected]ee41e7d22011-10-14 19:34:09291 const gfx::Rect& resizer_rect,
292 bool is_fullscreen);
[email protected]b5913d72012-02-07 22:26:54293 void OnChangeResizeRect(const gfx::Rect& resizer_rect);
[email protected]941e4552010-02-01 21:23:43294 virtual void OnWasHidden();
[email protected]9e2e4632012-07-27 16:38:41295 virtual void OnWasShown(bool needs_repainting);
[email protected]992db4c2011-05-12 15:37:15296 virtual void OnWasSwappedOut();
[email protected]53d3f302009-12-21 04:42:05297 void OnUpdateRectAck();
[email protected]8400e032010-02-26 18:50:11298 void OnCreateVideoAck(int32 video_id);
299 void OnUpdateVideoAck(int32 video_id);
[email protected]2533ce12009-05-09 00:02:24300 void OnRequestMoveAck();
[email protected]fa7b1dc2010-06-23 17:53:04301 void OnSetInputMethodActive(bool is_active);
[email protected]56ea1a62011-05-30 07:05:57302 virtual void OnImeSetComposition(
[email protected]fa7b1dc2010-06-23 17:53:04303 const string16& text,
304 const std::vector<WebKit::WebCompositionUnderline>& underlines,
305 int selection_start,
306 int selection_end);
[email protected]4de6d1692011-10-12 08:45:44307 virtual void OnImeConfirmComposition(
308 const string16& text, const ui::Range& replacement_range);
[email protected]3d9ec5052013-01-02 22:05:25309 void OnPaintAtSize(const TransportDIB::Handle& dib_id,
310 int tag,
311 const gfx::Size& page_size,
312 const gfx::Size& desired_size);
[email protected]0bc1f572013-04-17 01:46:31313 void OnRepaint(gfx::Size size_to_paint);
[email protected]4a9dba42013-04-29 18:24:22314 void OnSmoothScrollCompleted();
[email protected]4873c7d2009-07-16 06:36:28315 void OnSetTextDirection(WebKit::WebTextDirection direction);
[email protected]872ae5b2011-05-26 20:20:50316 void OnGetFPS();
[email protected]6131a642012-06-15 23:26:53317 void OnScreenInfoChanged(const WebKit::WebScreenInfo& screen_info);
[email protected]80ad8622012-11-07 16:33:03318 void OnUpdateScreenRects(const gfx::Rect& view_screen_rect,
319 const gfx::Rect& window_screen_rect);
[email protected]105dffb42013-02-20 03:46:21320#if defined(OS_ANDROID)
321 void OnImeBatchStateChanged(bool is_begin);
[email protected]2384b6c2013-02-28 23:58:51322 void OnShowImeIfNeeded();
[email protected]105dffb42013-02-20 03:46:21323#endif
[email protected]51a49502013-03-23 01:50:19324 void OnSnapshot(const gfx::Rect& src_subrect);
initial.commit09911bf2008-07-26 23:55:29325
[email protected]847a2582013-03-09 02:29:51326 // Notify the compositor about a change in viewport size. This should be
327 // used only with auto resize mode WebWidgets, as normal WebWidgets should
328 // go through OnResize.
[email protected]97e1bf72013-03-06 14:06:05329 void AutoResizeCompositor();
330
[email protected]468ac582012-11-20 00:53:19331 virtual void SetDeviceScaleFactor(float device_scale_factor);
332
[email protected]29ed96a2012-02-04 18:12:16333 // Override points to notify derived classes that a paint has happened.
334 // WillInitiatePaint happens when we're about to generate a new bitmap and
335 // send it to the browser. DidInitiatePaint happens when that has completed,
336 // and subsequent rendering won't affect the painted content. DidFlushPaint
337 // happens once we've received the ACK that the screen has been updated.
338 // For a given paint operation, these overrides will always be called in the
339 // order WillInitiatePaint, DidInitiatePaint, DidFlushPaint.
340 virtual void WillInitiatePaint() {}
[email protected]00c39612010-03-06 02:53:28341 virtual void DidInitiatePaint() {}
342 virtual void DidFlushPaint() {}
[email protected]a2f6bc112009-06-27 16:27:25343
[email protected]65225772011-05-12 21:10:24344 // Override and return true when the widget is rendered with a graphics
[email protected]37a6f302011-07-11 23:43:08345 // context that supports asynchronous swapbuffers. When returning true, the
346 // subclass must call OnSwapBuffersPosted() when swap is posted,
347 // OnSwapBuffersComplete() when swaps complete, and OnSwapBuffersAborted if
348 // the context is lost.
[email protected]65225772011-05-12 21:10:24349 virtual bool SupportsAsynchronousSwapBuffers();
[email protected]ed7defa2013-03-12 21:29:59350 virtual GURL GetURLForGraphicsContext3D();
[email protected]65225772011-05-12 21:10:24351
[email protected]479b0172012-10-29 19:27:09352 virtual bool ForceCompositingModeEnabled();
353
[email protected]ed7defa2013-03-12 21:29:59354 // WebGraphicsContext3DSwapBuffersClient implementation.
355
356 // Called by a GraphicsContext associated with this view when swapbuffers
357 // is posted, completes or is aborted.
358 virtual void OnViewContextSwapBuffersPosted() OVERRIDE;
359 virtual void OnViewContextSwapBuffersComplete() OVERRIDE;
360 virtual void OnViewContextSwapBuffersAborted() OVERRIDE;
[email protected]65225772011-05-12 21:10:24361
[email protected]ca4847f2010-09-24 05:39:15362 // Detects if a suitable opaque plugin covers the given paint bounds with no
363 // compositing necessary.
364 //
[email protected]719b36f2010-12-22 20:36:46365 // Returns the plugin instance that's the source of the paint if the paint
366 // can be handled by just blitting the plugin bitmap. In this case, the
367 // location, clipping, and ID of the backing store will be filled into the
368 // given output parameters.
[email protected]ca4847f2010-09-24 05:39:15369 //
[email protected]719b36f2010-12-22 20:36:46370 // A return value of null means optimized painting can not be used and we
[email protected]ca4847f2010-09-24 05:39:15371 // should continue with the normal painting code path.
[email protected]719b36f2010-12-22 20:36:46372 virtual webkit::ppapi::PluginInstance* GetBitmapForOptimizedPluginPaint(
[email protected]ca4847f2010-09-24 05:39:15373 const gfx::Rect& paint_bounds,
374 TransportDIB** dib,
375 gfx::Rect* location,
[email protected]0f3a2d12012-09-01 03:37:20376 gfx::Rect* clip,
377 float* scale_factor);
[email protected]ca4847f2010-09-24 05:39:15378
[email protected]d54169e92011-01-21 09:19:52379 // Gets the scroll offset of this widget, if this widget has a notion of
380 // scroll offset.
[email protected]ceb36f7d2012-10-31 18:33:24381 virtual gfx::Vector2d GetScrollOffset();
[email protected]d54169e92011-01-21 09:19:52382
[email protected]bee16aab2009-08-26 15:55:03383 // Sets the "hidden" state of this widget. All accesses to is_hidden_ should
384 // use this method so that we can properly inform the RenderThread of our
385 // state.
386 void SetHidden(bool hidden);
387
[email protected]2b624c562011-10-27 22:58:26388 void WillToggleFullscreen();
389 void DidToggleFullscreen();
390
[email protected]674741932009-02-04 23:44:46391 bool next_paint_is_resize_ack() const;
392 bool next_paint_is_restore_ack() const;
393 void set_next_paint_is_resize_ack();
394 void set_next_paint_is_restore_ack();
395 void set_next_paint_is_repaint_ack();
[email protected]ec7dc112008-08-06 05:30:12396
[email protected]ce2b28e2012-08-09 15:53:57397 void set_throttle_input_events(bool throttle_input_events) {
398 throttle_input_events_ = throttle_input_events;
399 }
400
[email protected]e99ef6f2011-10-16 01:13:00401 // Checks if the text input state and compose inline mode have been changed.
[email protected]fa7b1dc2010-06-23 17:53:04402 // If they are changed, the new value will be sent to the browser process.
[email protected]3306f262012-09-21 19:20:42403 // |show_ime_if_needed| should be SHOW_IME_IF_NEEDED iff the update may cause
404 // the ime to be displayed, e.g. after a tap on an input field on mobile.
405 void UpdateTextInputState(ShowIme show_ime);
[email protected]e99ef6f2011-10-16 01:13:00406
407 // Checks if the selection bounds have been changed. If they are changed,
408 // the new value will be sent to the browser process.
[email protected]58b48a0d2012-06-13 07:01:35409 virtual void UpdateSelectionBounds();
410
411 // Checks if the composition range or composition character bounds have been
412 // changed. If they are changed, the new value will be sent to the browser
413 // process.
414 virtual void UpdateCompositionInfo(
415 const ui::Range& range,
416 const std::vector<gfx::Rect>& character_bounds);
417
[email protected]56ea1a62011-05-30 07:05:57418 // Override point to obtain that the current input method state and caret
419 // position.
[email protected]ad26ef42011-06-17 07:59:45420 virtual ui::TextInputType GetTextInputType();
[email protected]3f783362011-10-21 22:40:50421 virtual void GetSelectionBounds(gfx::Rect* start, gfx::Rect* end);
[email protected]5b739cb2012-08-21 20:35:21422 virtual ui::TextInputType WebKitToUiTextInputType(
423 WebKit::WebTextInputType type);
[email protected]ad26ef42011-06-17 07:59:45424
[email protected]58b48a0d2012-06-13 07:01:35425 // Override point to obtain that the current composition character bounds.
426 // In the case of surrogate pairs, the character is treated as two characters:
427 // the bounds for first character is actual one, and the bounds for second
428 // character is zero width rectangle.
429 virtual void GetCompositionCharacterBounds(
430 std::vector<gfx::Rect>* character_bounds);
431
432 // Returns true if the composition range or composition character bounds
433 // should be sent to the browser process.
434 bool ShouldUpdateCompositionInfo(
435 const ui::Range& range,
436 const std::vector<gfx::Rect>& bounds);
437
[email protected]ad26ef42011-06-17 07:59:45438 // Override point to obtain that the current input method state about
439 // composition text.
440 virtual bool CanComposeInline();
[email protected]56ea1a62011-05-30 07:05:57441
initial.commit09911bf2008-07-26 23:55:29442 // Tells the renderer it does not have focus. Used to prevent us from getting
443 // the focus on our own when the browser did not focus us.
444 void ClearFocus();
445
[email protected]2533ce12009-05-09 00:02:24446 // Set the pending window rect.
447 // Because the real render_widget is hosted in another process, there is
448 // a time period where we may have set a new window rect which has not yet
449 // been processed by the browser. So we maintain a pending window rect
450 // size. If JS code sets the WindowRect, and then immediately calls
451 // GetWindowRect() we'll use this pending window rect as the size.
452 void SetPendingWindowRect(const WebKit::WebRect& r);
453
[email protected]446705872009-09-10 07:22:48454 // Called by OnHandleInputEvent() to notify subclasses that a key event was
455 // just handled.
456 virtual void DidHandleKeyEvent() {}
457
[email protected]67bfb83f2011-09-22 03:36:37458 // Called by OnHandleInputEvent() to notify subclasses that a mouse event is
459 // about to be handled.
460 // Returns true if no further handling is needed. In that case, the event
461 // won't be sent to WebKit or trigger DidHandleMouseEvent().
462 virtual bool WillHandleMouseEvent(const WebKit::WebMouseEvent& event);
463
[email protected]41d86852012-11-07 12:23:24464 // Called by OnHandleInputEvent() to notify subclasses that a gesture event is
465 // about to be handled.
466 // Returns true if no further handling is needed. In that case, the event
467 // won't be sent to WebKit.
468 virtual bool WillHandleGestureEvent(const WebKit::WebGestureEvent& event);
469
[email protected]6a8ddba52010-09-05 04:38:06470 // Called by OnHandleInputEvent() to notify subclasses that a mouse event was
471 // just handled.
472 virtual void DidHandleMouseEvent(const WebKit::WebMouseEvent& event) {}
473
[email protected]2d0f2e92011-10-03 09:02:24474 // Called by OnHandleInputEvent() to notify subclasses that a touch event was
475 // just handled.
476 virtual void DidHandleTouchEvent(const WebKit::WebTouchEvent& event) {}
477
[email protected]3d5c243b2012-11-30 00:26:01478 // Check whether the WebWidget has any touch event handlers registered
479 // at the given point.
480 virtual bool HasTouchEventHandlersAt(const gfx::Point& point) const;
481
[email protected]ce6689f2013-03-29 12:52:55482 // Check whether the WebWidget has any touch event handlers registered.
483 virtual void hasTouchEventHandlers(bool has_handlers);
484
[email protected]ed7defa2013-03-12 21:29:59485 // Creates a 3D context associated with this view.
[email protected]3ae68c52013-04-12 06:10:05486 WebGraphicsContext3DCommandBufferImpl* CreateGraphicsContext3D(
[email protected]ed7defa2013-03-12 21:29:59487 const WebKit::WebGraphicsContext3D::Attributes& attributes);
488
[email protected]51a49502013-03-23 01:50:19489 bool OnSnapshotHelper(const gfx::Rect& src_subrect, SkBitmap* bitmap);
490
initial.commit09911bf2008-07-26 23:55:29491 // Routing ID that allows us to communicate to the parent browser process
492 // RenderWidgetHost. When MSG_ROUTING_NONE, no messages may be sent.
493 int32 routing_id_;
494
[email protected]9f4f3322012-01-18 22:29:56495 int32 surface_id_;
496
[email protected]c5b3b5e2009-02-13 06:41:11497 // We are responsible for destroying this object via its Close method.
[email protected]4873c7d2009-07-16 06:36:28498 WebKit::WebWidget* webwidget_;
initial.commit09911bf2008-07-26 23:55:29499
[email protected]8926c602013-01-23 05:32:06500 // This is lazily constructed and must not outlive webwidget_.
[email protected]ba91a792013-02-06 09:48:28501 scoped_ptr<RenderWidgetCompositor> compositor_;
[email protected]8926c602013-01-23 05:32:06502
initial.commit09911bf2008-07-26 23:55:29503 // Set to the ID of the view that initiated creating this view, if any. When
504 // the view was initiated by the browser (the common case), this will be
505 // MSG_ROUTING_NONE. This is used in determining ownership when opening
506 // child tabs. See RenderWidget::createWebViewWithRequest.
507 //
508 // This ID may refer to an invalid view if that view is closed before this
509 // view is.
510 int32 opener_id_;
511
512 // The position where this view should be initially shown.
513 gfx::Rect initial_pos_;
514
[email protected]fc4404d2012-11-07 19:53:30515 bool init_complete_;
initial.commit09911bf2008-07-26 23:55:29516
517 // We store the current cursor object so we can avoid spamming SetCursor
518 // messages.
519 WebCursor current_cursor_;
[email protected]88efb7ec2009-07-14 16:32:59520
initial.commit09911bf2008-07-26 23:55:29521 // The size of the RenderWidget.
522 gfx::Size size_;
523
[email protected]b4d08452010-10-05 17:34:35524 // The TransportDIB that is being used to transfer an image to the browser.
525 TransportDIB* current_paint_buf_;
initial.commit09911bf2008-07-26 23:55:29526
[email protected]552e6002009-11-19 05:24:57527 PaintAggregator paint_aggregator_;
initial.commit09911bf2008-07-26 23:55:29528
[email protected]60d47ac2013-03-01 23:42:44529 // The size of the view's backing surface in non-DPI-adjusted pixels.
530 gfx::Size physical_backing_size_;
531
[email protected]d9083762013-03-24 01:36:40532 // The height of the physical backing surface that is overdrawn opaquely in
533 // the browser, for example by an on-screen-keyboard (in DPI-adjusted pixels).
534 float overdraw_bottom_height_;
535
[email protected]f21c613a2009-02-12 14:46:17536 // The area that must be reserved for drawing the resize corner.
537 gfx::Rect resizer_rect_;
538
[email protected]53d3f302009-12-21 04:42:05539 // Flags for the next ViewHostMsg_UpdateRect message.
initial.commit09911bf2008-07-26 23:55:29540 int next_paint_flags_;
541
[email protected]872ae5b2011-05-26 20:20:50542 // Filtered time per frame based on UpdateRect messages.
543 float filtered_time_per_frame_;
544
[email protected]53d3f302009-12-21 04:42:05545 // True if we are expecting an UpdateRect_ACK message (i.e., that a
546 // UpdateRect message has been sent).
547 bool update_reply_pending_;
initial.commit09911bf2008-07-26 23:55:29548
[email protected]847a2582013-03-09 02:29:51549 // Whether the WebWidget is in auto resize mode, which is used for example
550 // by extension popups.
551 bool auto_resize_mode_;
552
[email protected]ea3ee0a2012-05-15 03:43:09553 // True if we need to send an UpdateRect message to notify the browser about
554 // an already-completed auto-resize.
555 bool need_update_rect_for_auto_resize_;
556
[email protected]65225772011-05-12 21:10:24557 // True if the underlying graphics context supports asynchronous swap.
558 // Cached on the RenderWidget because determining support is costly.
559 bool using_asynchronous_swapbuffers_;
560
561 // Number of OnSwapBuffersComplete we are expecting. Incremented each time
562 // WebWidget::composite has been been performed when the RenderWidget subclass
563 // SupportsAsynchronousSwapBuffers. Decremented in OnSwapBuffers. Will block
564 // rendering.
565 int num_swapbuffers_complete_pending_;
566
567 // When accelerated rendering is on, is the maximum number of swapbuffers that
568 // can be outstanding before we start throttling based on
569 // OnSwapBuffersComplete callback.
[email protected]82ca9b92011-09-12 23:33:07570 static const int kMaxSwapBuffersPending = 2;
[email protected]65225772011-05-12 21:10:24571
initial.commit09911bf2008-07-26 23:55:29572 // Set to true if we should ignore RenderWidget::Show calls.
573 bool did_show_;
574
575 // Indicates that we shouldn't bother generated paint events.
576 bool is_hidden_;
577
[email protected]ee41e7d22011-10-14 19:34:09578 // Indicates that we are in fullscreen mode.
579 bool is_fullscreen_;
580
initial.commit09911bf2008-07-26 23:55:29581 // Indicates that we should be repainted when restored. This flag is set to
582 // true if we receive an invalidation / scroll event from webkit while our
583 // is_hidden_ flag is set to true. This is used to force a repaint once we
584 // restore to account for the fact that our host would not know about the
585 // invalidation / scroll event(s) from webkit while we are hidden.
586 bool needs_repainting_on_restore_;
587
588 // Indicates whether we have been focused/unfocused by the browser.
589 bool has_focus_;
590
[email protected]5dd768212009-08-13 23:34:49591 // Are we currently handling an input event?
592 bool handling_input_event_;
593
[email protected]e8f775f2013-02-14 21:00:50594 // Are we currently handling an ime event?
595 bool handling_ime_event_;
596
initial.commit09911bf2008-07-26 23:55:29597 // True if we have requested this widget be closed. No more messages will
598 // be sent, except for a Close.
599 bool closing_;
600
[email protected]992db4c2011-05-12 15:37:15601 // Whether this RenderWidget is currently swapped out, such that the view is
602 // being rendered by another process. If all RenderWidgets in a process are
603 // swapped out, the process can exit.
604 bool is_swapped_out_;
605
[email protected]fa7b1dc2010-06-23 17:53:04606 // Indicates if an input method is active in the browser process.
607 bool input_method_is_active_;
initial.commit09911bf2008-07-26 23:55:29608
[email protected]5b739cb2012-08-21 20:35:21609 // Stores information about the current text input.
610 WebKit::WebTextInputInfo text_input_info_;
611
[email protected]fa7b1dc2010-06-23 17:53:04612 // Stores the current text input type of |webwidget_|.
[email protected]ad26ef42011-06-17 07:59:45613 ui::TextInputType text_input_type_;
614
615 // Stores the current type of composition text rendering of |webwidget_|.
616 bool can_compose_inline_;
[email protected]fa7b1dc2010-06-23 17:53:04617
[email protected]e99ef6f2011-10-16 01:13:00618 // Stores the current selection bounds.
[email protected]7c8873e2013-02-05 08:03:01619 gfx::Rect selection_focus_rect_;
620 gfx::Rect selection_anchor_rect_;
initial.commit09911bf2008-07-26 23:55:29621
[email protected]58b48a0d2012-06-13 07:01:35622 // Stores the current composition character bounds.
623 std::vector<gfx::Rect> composition_character_bounds_;
624
625 // Stores the current composition range.
626 ui::Range composition_range_;
627
[email protected]3e2b375b2010-04-07 17:03:12628 // The kind of popup this widget represents, NONE if not a popup.
629 WebKit::WebPopupType popup_type_;
[email protected]0ebf3872008-11-07 21:35:03630
initial.commit09911bf2008-07-26 23:55:29631 // Holds all the needed plugin window moves for a scroll.
[email protected]191eb3f72010-12-21 06:27:50632 typedef std::vector<webkit::npapi::WebPluginGeometry> WebPluginGeometryVector;
[email protected]268654772009-08-06 23:02:04633 WebPluginGeometryVector plugin_window_moves_;
initial.commit09911bf2008-07-26 23:55:29634
[email protected]699ab0d2009-04-23 23:19:14635 // A custom background for the widget.
636 SkBitmap background_;
637
[email protected]80ad8622012-11-07 16:33:03638 // While we are waiting for the browser to update window sizes, we track the
639 // pending size temporarily.
[email protected]2533ce12009-05-09 00:02:24640 int pending_window_rect_count_;
641 WebKit::WebRect pending_window_rect_;
642
[email protected]80ad8622012-11-07 16:33:03643 // The screen rects of the view and the window that contains it.
644 gfx::Rect view_screen_rect_;
645 gfx::Rect window_screen_rect_;
646
[email protected]12fbad812009-09-01 18:21:24647 scoped_ptr<IPC::Message> pending_input_event_ack_;
648
[email protected]b68a0e52011-12-08 15:11:12649 // Indicates if the next sequence of Char events should be suppressed or not.
650 bool suppress_next_char_events_;
651
[email protected]a79d8a632010-11-18 22:35:56652 // Set to true if painting to the window is handled by the accelerated
653 // compositor.
654 bool is_accelerated_compositing_active_;
[email protected]edbcde932010-05-07 17:10:46655
[email protected]350ce8702012-03-09 04:23:38656 base::OneShotTimer<RenderWidget> animation_timer_;
[email protected]5f8b1022011-01-21 23:34:50657 base::Time animation_floor_time_;
658 bool animation_update_pending_;
[email protected]65225772011-05-12 21:10:24659 bool invalidation_task_posted_;
[email protected]5f8b1022011-01-21 23:34:50660
[email protected]bd37ae252011-06-03 01:28:18661 bool has_disable_gpu_vsync_switch_;
[email protected]0fb93f52011-05-18 23:13:56662 base::TimeTicks last_do_deferred_update_time_;
663
[email protected]b63d58d2012-11-26 22:37:44664 cc::RenderingStats software_stats_;
[email protected]fef5e3972012-08-07 03:59:47665
[email protected]aa4117f2011-12-09 22:19:21666 // UpdateRect parameters for the current compositing pass. This is used to
667 // pass state between DoDeferredUpdate and OnSwapBuffersPosted.
668 scoped_ptr<ViewHostMsg_UpdateRect_Params> pending_update_params_;
669
670 // Queue of UpdateRect messages corresponding to a SwapBuffers. We want to
671 // delay sending of UpdateRect until the corresponding SwapBuffers has been
672 // executed. Since we can have several in flight, we need to keep them in a
673 // queue. Note: some SwapBuffers may not correspond to an update, in which
674 // case NULL is added to the queue.
675 std::deque<ViewHostMsg_UpdateRect*> updates_pending_swap_;
676
[email protected]842f10652012-06-06 01:54:04677 // Properties of the screen hosting this RenderWidget instance.
678 WebKit::WebScreenInfo screen_info_;
679
[email protected]f1cccb32012-06-06 18:29:59680 // The device scale factor. This value is computed from the DPI entries in
681 // |screen_info_| on some platforms, and defaults to 1 on other platforms.
[email protected]faec7b12012-06-19 14:42:13682 float device_scale_factor_;
[email protected]f1cccb32012-06-06 18:29:59683
[email protected]ce2b28e2012-08-09 15:53:57684 // Specifies whether input event throttling is enabled for this widget.
685 bool throttle_input_events_;
686
[email protected]0e241b4b2012-08-18 09:06:27687 // State associated with the BeginSmoothScroll synthetic scrolling function.
[email protected]4a9dba42013-04-29 18:24:22688 SmoothScrollCompletionCallback pending_smooth_scroll_gesture_;
[email protected]0e241b4b2012-08-18 09:06:27689
[email protected]cb6430932012-10-31 00:53:36690 // Specified whether the compositor will run in its own thread.
691 bool is_threaded_compositing_enabled_;
692
[email protected]ed7defa2013-03-12 21:29:59693 base::WeakPtrFactory<RenderWidget> weak_ptr_factory_;
694
[email protected]05d478752009-04-08 23:38:16695 DISALLOW_COPY_AND_ASSIGN(RenderWidget);
initial.commit09911bf2008-07-26 23:55:29696};
697
[email protected]e9ff79c2012-10-19 21:31:26698} // namespace content
699
[email protected]2cff0052011-03-18 16:51:44700#endif // CONTENT_RENDERER_RENDER_WIDGET_H_