// Copyright (c) 2012 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #ifndef CONTENT_RENDERER_RENDER_WIDGET_H_ #define CONTENT_RENDERER_RENDER_WIDGET_H_ #include <deque> #include <map> #include "base/auto_reset.h" #include "base/basictypes.h" #include "base/compiler_specific.h" #include "base/memory/ref_counted.h" #include "base/memory/scoped_ptr.h" #include "base/observer_list.h" #include "base/time/time.h" #include "base/timer/timer.h" #include "cc/debug/rendering_stats_instrumentation.h" #include "content/common/content_export.h" #include "content/common/cursors/webcursor.h" #include "content/common/gpu/client/webgraphicscontext3d_command_buffer_impl.h" #include "content/common/input/synthetic_gesture_params.h" #include "ipc/ipc_listener.h" #include "ipc/ipc_sender.h" #include "third_party/WebKit/public/platform/WebRect.h" #include "third_party/WebKit/public/web/WebCompositionUnderline.h" #include "third_party/WebKit/public/web/WebInputEvent.h" #include "third_party/WebKit/public/web/WebPopupType.h" #include "third_party/WebKit/public/web/WebTextDirection.h" #include "third_party/WebKit/public/web/WebTextInputInfo.h" #include "third_party/WebKit/public/web/WebTouchAction.h" #include "third_party/WebKit/public/web/WebWidget.h" #include "third_party/WebKit/public/web/WebWidgetClient.h" #include "third_party/skia/include/core/SkBitmap.h" #include "ui/base/ime/text_input_mode.h" #include "ui/base/ime/text_input_type.h" #include "ui/base/ui_base_types.h" #include "ui/gfx/native_widget_types.h" #include "ui/gfx/range/range.h" #include "ui/gfx/rect.h" #include "ui/gfx/vector2d.h" #include "ui/gfx/vector2d_f.h" #include "ui/surface/transport_dib.h" struct ViewHostMsg_UpdateRect_Params; struct ViewMsg_Resize_Params; class ViewHostMsg_UpdateRect; namespace IPC { class SyncMessage; } namespace blink { struct WebDeviceEmulationParams; class WebGestureEvent; class WebKeyboardEvent; class WebMouseEvent; class WebTouchEvent; } namespace cc { class OutputSurface; } namespace gfx { class Range; } namespace content { class ExternalPopupMenu; class PepperPluginInstanceImpl; class RenderFrameImpl; class RenderFrameProxy; class RenderWidgetCompositor; class RenderWidgetTest; class ResizingModeSelector; struct ContextMenuParams; struct WebPluginGeometry; // RenderWidget provides a communication bridge between a WebWidget and // a RenderWidgetHost, the latter of which lives in a different process. class CONTENT_EXPORT RenderWidget : public IPC::Listener, public IPC::Sender, NON_EXPORTED_BASE(virtual public blink::WebWidgetClient), public base::RefCounted<RenderWidget> { public: // Creates a new RenderWidget. The opener_id is the routing ID of the // RenderView that this widget lives inside. static RenderWidget* Create(int32 opener_id, blink::WebPopupType popup_type, const blink::WebScreenInfo& screen_info); // Creates a WebWidget based on the popup type. static blink::WebWidget* CreateWebWidget(RenderWidget* render_widget); int32 routing_id() const { return routing_id_; } int32 surface_id() const { return surface_id_; } blink::WebWidget* webwidget() const { return webwidget_; } gfx::Size size() const { return size_; } bool has_focus() const { return has_focus_; } bool is_fullscreen() const { return is_fullscreen_; } bool is_hidden() const { return is_hidden_; } bool handling_input_event() const { return handling_input_event_; } // Temporary for debugging purposes... bool closing() const { return closing_; } bool is_swapped_out() { return is_swapped_out_; } ui::MenuSourceType context_menu_source_type() { return context_menu_source_type_; } bool has_host_context_menu_location() { return has_host_context_menu_location_; } gfx::Point host_context_menu_location() { return host_context_menu_location_; } // Functions to track out-of-process frames for special notifications. void RegisterRenderFrameProxy(RenderFrameProxy* proxy); void UnregisterRenderFrameProxy(RenderFrameProxy* proxy); // Functions to track all RenderFrame objects associated with this // RenderWidget. void RegisterRenderFrame(RenderFrameImpl* frame); void UnregisterRenderFrame(RenderFrameImpl* frame); #if defined(VIDEO_HOLE) void RegisterVideoHoleFrame(RenderFrameImpl* frame); void UnregisterVideoHoleFrame(RenderFrameImpl* frame); #endif // defined(VIDEO_HOLE) // IPC::Listener virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE; // IPC::Sender virtual bool Send(IPC::Message* msg) OVERRIDE; // blink::WebWidgetClient virtual void suppressCompositorScheduling(bool enable); virtual void willBeginCompositorFrame(); virtual void didAutoResize(const blink::WebSize& new_size); virtual void initializeLayerTreeView(); virtual blink::WebLayerTreeView* layerTreeView(); virtual void didBecomeReadyForAdditionalInput(); virtual void didCommitAndDrawCompositorFrame(); virtual void didCompleteSwapBuffers(); virtual void scheduleComposite(); virtual void didFocus(); virtual void didBlur(); virtual void didChangeCursor(const blink::WebCursorInfo&); virtual void closeWidgetSoon(); virtual void show(blink::WebNavigationPolicy); virtual void runModal() {} virtual blink::WebRect windowRect(); virtual void setToolTipText(const blink::WebString& text, blink::WebTextDirection hint); virtual void setWindowRect(const blink::WebRect&); virtual blink::WebRect windowResizerRect(); virtual blink::WebRect rootWindowRect(); virtual blink::WebScreenInfo screenInfo(); virtual float deviceScaleFactor(); virtual void resetInputMethod(); virtual void didHandleGestureEvent(const blink::WebGestureEvent& event, bool event_cancelled); // Begins the compositor's scheduler to start producing frames. void StartCompositor(); // Called when a plugin is moved. These events are queued up and sent with // the next paint or scroll message to the host. void SchedulePluginMove(const WebPluginGeometry& move); // Called when a plugin window has been destroyed, to make sure the currently // pending moves don't try to reference it. void CleanupWindowInPluginMoves(gfx::PluginWindowHandle window); RenderWidgetCompositor* compositor() const; const ui::LatencyInfo* current_event_latency_info() const { return current_event_latency_info_; } virtual scoped_ptr<cc::OutputSurface> CreateOutputSurface(bool fallback); // Callback for use with synthetic gestures (e.g. BeginSmoothScroll). typedef base::Callback<void()> SyntheticGestureCompletionCallback; // Send a synthetic gesture to the browser to be queued to the synthetic // gesture controller. void QueueSyntheticGesture( scoped_ptr<SyntheticGestureParams> gesture_params, const SyntheticGestureCompletionCallback& callback); // Close the underlying WebWidget. virtual void Close(); // Notifies about a compositor frame commit operation having finished. virtual void DidCommitCompositorFrame(); // Handle common setup/teardown for handling IME events. void StartHandlingImeEvent(); void FinishHandlingImeEvent(); // Returns whether we currently should handle an IME event. bool ShouldHandleImeEvent(); virtual void InstrumentWillBeginFrame(int frame_id) {} virtual void InstrumentDidBeginFrame() {} virtual void InstrumentDidCancelFrame() {} virtual void InstrumentWillComposite() {} // When paused in debugger, we send ack for mouse event early. This ensures // that we continue receiving mouse moves and pass them to debugger. Returns // whether we are paused in mouse move event and have sent the ack. bool SendAckForMouseMoveFromDebugger(); // When resumed from pause in debugger while handling mouse move, // we should not send an extra ack (see SendAckForMouseMoveFromDebugger). void IgnoreAckForMouseMoveFromDebugger(); // ScreenMetricsEmulator class manages screen emulation inside a render // widget. This includes resizing, placing view on the screen at desired // position, changing device scale factor, and scaling down the whole // widget if required to fit into the browser window. class ScreenMetricsEmulator; // Emulates screen and widget metrics. Supplied values override everything // coming from host. void EnableScreenMetricsEmulation( const blink::WebDeviceEmulationParams& params); void DisableScreenMetricsEmulation(); void SetPopupOriginAdjustmentsForEmulation(ScreenMetricsEmulator* emulator); void ScheduleCompositeWithForcedRedraw(); // Called by the compositor in single-threaded mode when a swap is posted, // completes or is aborted. void OnSwapBuffersPosted(); void OnSwapBuffersComplete(); void OnSwapBuffersAborted(); // Checks if the selection bounds have been changed. If they are changed, // the new value will be sent to the browser process. void UpdateSelectionBounds(); virtual void GetSelectionBounds(gfx::Rect* start, gfx::Rect* end); void OnShowHostContextMenu(ContextMenuParams* params); enum ShowIme { SHOW_IME_IF_NEEDED, NO_SHOW_IME, }; enum ChangeSource { FROM_NON_IME, FROM_IME, }; // |show_ime| should be SHOW_IME_IF_NEEDED iff the update may cause the ime to // be displayed, e.g. after a tap on an input field on mobile. // |change_source| should be FROM_NON_IME when the renderer has to wait for // the browser to acknowledge the change before the renderer handles any more // IME events. This is when the text change did not originate from the IME in // the browser side, such as changes by JavaScript or autofill. void UpdateTextInputState(ShowIme show_ime, ChangeSource change_source); #if defined(OS_MACOSX) || defined(USE_AURA) // Checks if the composition range or composition character bounds have been // changed. If they are changed, the new value will be sent to the browser // process. void UpdateCompositionInfo(bool should_update_range); #endif #if defined(OS_ANDROID) void DidChangeBodyBackgroundColor(SkColor bg_color); #endif protected: // Friend RefCounted so that the dtor can be non-public. Using this class // without ref-counting is an error. friend class base::RefCounted<RenderWidget>; // For unit tests. friend class RenderWidgetTest; enum ResizeAck { SEND_RESIZE_ACK, NO_RESIZE_ACK, }; RenderWidget(blink::WebPopupType popup_type, const blink::WebScreenInfo& screen_info, bool swapped_out, bool hidden, bool never_visible); virtual ~RenderWidget(); // Initializes this view with the given opener. CompleteInit must be called // later. bool Init(int32 opener_id); // Called by Init and subclasses to perform initialization. bool DoInit(int32 opener_id, blink::WebWidget* web_widget, IPC::SyncMessage* create_widget_message); // Finishes creation of a pending view started with Init. void CompleteInit(); // Sets whether this RenderWidget has been swapped out to be displayed by // a RenderWidget in a different process. If so, no new IPC messages will be // sent (only ACKs) and the process is free to exit when there are no other // active RenderWidgets. void SetSwappedOut(bool is_swapped_out); void FlushPendingInputEventAck(); void DoDeferredClose(); void DoDeferredSetWindowRect(const blink::WebRect& pos); // Resizes the render widget. void Resize(const gfx::Size& new_size, const gfx::Size& physical_backing_size, float overdraw_bottom_height, const gfx::Size& visible_viewport_size, const gfx::Rect& resizer_rect, bool is_fullscreen, ResizeAck resize_ack); // Used to force the size of a window when running layout tests. void ResizeSynchronously(const gfx::Rect& new_position); virtual void SetScreenMetricsEmulationParameters( float device_scale_factor, const gfx::Point& root_layer_offset, float root_layer_scale); #if defined(OS_MACOSX) || defined(OS_ANDROID) void SetExternalPopupOriginAdjustmentsForEmulation( ExternalPopupMenu* popup, ScreenMetricsEmulator* emulator); #endif // RenderWidget IPC message handlers void OnHandleInputEvent(const blink::WebInputEvent* event, const ui::LatencyInfo& latency_info, bool keyboard_shortcut); void OnCursorVisibilityChange(bool is_visible); void OnMouseCaptureLost(); virtual void OnSetFocus(bool enable); virtual void OnClose(); void OnCreatingNewAck(); virtual void OnResize(const ViewMsg_Resize_Params& params); void OnChangeResizeRect(const gfx::Rect& resizer_rect); virtual void OnWasHidden(); virtual void OnWasShown(bool needs_repainting); virtual void OnWasSwappedOut(); void OnCreateVideoAck(int32 video_id); void OnUpdateVideoAck(int32 video_id); void OnRequestMoveAck(); void OnSetInputMethodActive(bool is_active); void OnCandidateWindowShown(); void OnCandidateWindowUpdated(); void OnCandidateWindowHidden(); virtual void OnImeSetComposition( const base::string16& text, const std::vector<blink::WebCompositionUnderline>& underlines, int selection_start, int selection_end); virtual void OnImeConfirmComposition(const base::string16& text, const gfx::Range& replacement_range, bool keep_selection); void OnRepaint(gfx::Size size_to_paint); void OnSyntheticGestureCompleted(); void OnSetTextDirection(blink::WebTextDirection direction); void OnGetFPS(); void OnUpdateScreenRects(const gfx::Rect& view_screen_rect, const gfx::Rect& window_screen_rect); #if defined(OS_ANDROID) void OnShowImeIfNeeded(); // Whenever an IME event that needs an acknowledgement is sent to the browser, // the number of outstanding IME events that needs acknowledgement should be // incremented. All IME events will be dropped until we receive an ack from // the browser. void IncrementOutstandingImeEventAcks(); // Called by the browser process for every required IME acknowledgement. void OnImeEventAck(); #endif // Notify the compositor about a change in viewport size. This should be // used only with auto resize mode WebWidgets, as normal WebWidgets should // go through OnResize. void AutoResizeCompositor(); virtual void SetDeviceScaleFactor(float device_scale_factor); virtual bool SetDeviceColorProfile(const std::vector<char>& color_profile); virtual void OnOrientationChange(); // Override points to notify derived classes that a paint has happened. // DidInitiatePaint happens when that has completed, and subsequent rendering // won't affect the painted content. DidFlushPaint happens once we've received // the ACK that the screen has been updated. For a given paint operation, // these overrides will always be called in the order DidInitiatePaint, // DidFlushPaint. virtual void DidInitiatePaint() {} virtual void DidFlushPaint() {} virtual GURL GetURLForGraphicsContext3D(); // Gets the scroll offset of this widget, if this widget has a notion of // scroll offset. virtual gfx::Vector2d GetScrollOffset(); // Sets the "hidden" state of this widget. All accesses to is_hidden_ should // use this method so that we can properly inform the RenderThread of our // state. void SetHidden(bool hidden); void WillToggleFullscreen(); void DidToggleFullscreen(); bool next_paint_is_resize_ack() const; void set_next_paint_is_resize_ack(); void set_next_paint_is_repaint_ack(); // Override point to obtain that the current input method state and caret // position. virtual ui::TextInputType GetTextInputType(); virtual ui::TextInputType WebKitToUiTextInputType( blink::WebTextInputType type); #if defined(OS_MACOSX) || defined(USE_AURA) // Override point to obtain that the current composition character bounds. // In the case of surrogate pairs, the character is treated as two characters: // the bounds for first character is actual one, and the bounds for second // character is zero width rectangle. virtual void GetCompositionCharacterBounds( std::vector<gfx::Rect>* character_bounds); // Returns the range of the text that is being composed or the selection if // the composition does not exist. virtual void GetCompositionRange(gfx::Range* range); // Returns true if the composition range or composition character bounds // should be sent to the browser process. bool ShouldUpdateCompositionInfo( const gfx::Range& range, const std::vector<gfx::Rect>& bounds); #endif // Override point to obtain that the current input method state about // composition text. virtual bool CanComposeInline(); // Tells the renderer it does not have focus. Used to prevent us from getting // the focus on our own when the browser did not focus us. void ClearFocus(); // Set the pending window rect. // Because the real render_widget is hosted in another process, there is // a time period where we may have set a new window rect which has not yet // been processed by the browser. So we maintain a pending window rect // size. If JS code sets the WindowRect, and then immediately calls // GetWindowRect() we'll use this pending window rect as the size. void SetPendingWindowRect(const blink::WebRect& r); // Called by OnHandleInputEvent() to notify subclasses that a key event was // just handled. virtual void DidHandleKeyEvent() {} // Called by OnHandleInputEvent() to notify subclasses that a mouse event is // about to be handled. // Returns true if no further handling is needed. In that case, the event // won't be sent to WebKit or trigger DidHandleMouseEvent(). virtual bool WillHandleMouseEvent(const blink::WebMouseEvent& event); // Called by OnHandleInputEvent() to notify subclasses that a gesture event is // about to be handled. // Returns true if no further handling is needed. In that case, the event // won't be sent to WebKit. virtual bool WillHandleGestureEvent(const blink::WebGestureEvent& event); // Called by OnHandleInputEvent() to notify subclasses that a mouse event was // just handled. virtual void DidHandleMouseEvent(const blink::WebMouseEvent& event) {} // Called by OnHandleInputEvent() to notify subclasses that a touch event was // just handled. virtual void DidHandleTouchEvent(const blink::WebTouchEvent& event) {} // Check whether the WebWidget has any touch event handlers registered // at the given point. virtual bool HasTouchEventHandlersAt(const gfx::Point& point) const; // Check whether the WebWidget has any touch event handlers registered. virtual void hasTouchEventHandlers(bool has_handlers); // Tell the browser about the actions permitted for a new touch point. virtual void setTouchAction(blink::WebTouchAction touch_action); // Called when value of focused text field gets dirty, e.g. value is modified // by script, not by user input. virtual void didUpdateTextOfFocusedElementByNonUserInput(); // Creates a 3D context associated with this view. scoped_ptr<WebGraphicsContext3DCommandBufferImpl> CreateGraphicsContext3D(); // Routing ID that allows us to communicate to the parent browser process // RenderWidgetHost. When MSG_ROUTING_NONE, no messages may be sent. int32 routing_id_; int32 surface_id_; // We are responsible for destroying this object via its Close method. // May be NULL when the window is closing. blink::WebWidget* webwidget_; // This is lazily constructed and must not outlive webwidget_. scoped_ptr<RenderWidgetCompositor> compositor_; // Set to the ID of the view that initiated creating this view, if any. When // the view was initiated by the browser (the common case), this will be // MSG_ROUTING_NONE. This is used in determining ownership when opening // child tabs. See RenderWidget::createWebViewWithRequest. // // This ID may refer to an invalid view if that view is closed before this // view is. int32 opener_id_; // The position where this view should be initially shown. gfx::Rect initial_pos_; bool init_complete_; // We store the current cursor object so we can avoid spamming SetCursor // messages. WebCursor current_cursor_; // The size of the RenderWidget. gfx::Size size_; // The size of the view's backing surface in non-DPI-adjusted pixels. gfx::Size physical_backing_size_; // The height of the physical backing surface that is overdrawn opaquely in // the browser, for example by an on-screen-keyboard (in DPI-adjusted pixels). float overdraw_bottom_height_; // The size of the visible viewport in DPI-adjusted pixels. gfx::Size visible_viewport_size_; // The area that must be reserved for drawing the resize corner. gfx::Rect resizer_rect_; // Flags for the next ViewHostMsg_UpdateRect message. int next_paint_flags_; // Whether the WebWidget is in auto resize mode, which is used for example // by extension popups. bool auto_resize_mode_; // True if we need to send an UpdateRect message to notify the browser about // an already-completed auto-resize. bool need_update_rect_for_auto_resize_; // Set to true if we should ignore RenderWidget::Show calls. bool did_show_; // Indicates that we shouldn't bother generated paint events. bool is_hidden_; // Indicates that we are never visible, so never produce graphical output. bool never_visible_; // Indicates that we are in fullscreen mode. bool is_fullscreen_; // Indicates whether we have been focused/unfocused by the browser. bool has_focus_; // Are we currently handling an input event? bool handling_input_event_; // Are we currently handling an ime event? bool handling_ime_event_; // Type of the input event we are currently handling. blink::WebInputEvent::Type handling_event_type_; // Whether we should not send ack for the current mouse move. bool ignore_ack_for_mouse_move_from_debugger_; // True if we have requested this widget be closed. No more messages will // be sent, except for a Close. bool closing_; // Whether this RenderWidget is currently swapped out, such that the view is // being rendered by another process. If all RenderWidgets in a process are // swapped out, the process can exit. bool is_swapped_out_; // Indicates if an input method is active in the browser process. bool input_method_is_active_; // Stores information about the current text input. blink::WebTextInputInfo text_input_info_; // Stores the current text input type of |webwidget_|. ui::TextInputType text_input_type_; // Stores the current text input mode of |webwidget_|. ui::TextInputMode text_input_mode_; // Stores the current type of composition text rendering of |webwidget_|. bool can_compose_inline_; // Stores the current selection bounds. gfx::Rect selection_focus_rect_; gfx::Rect selection_anchor_rect_; // Stores the current composition character bounds. std::vector<gfx::Rect> composition_character_bounds_; // Stores the current composition range. gfx::Range composition_range_; // The kind of popup this widget represents, NONE if not a popup. blink::WebPopupType popup_type_; // Holds all the needed plugin window moves for a scroll. typedef std::vector<WebPluginGeometry> WebPluginGeometryVector; WebPluginGeometryVector plugin_window_moves_; // While we are waiting for the browser to update window sizes, we track the // pending size temporarily. int pending_window_rect_count_; blink::WebRect pending_window_rect_; // The screen rects of the view and the window that contains it. gfx::Rect view_screen_rect_; gfx::Rect window_screen_rect_; scoped_ptr<IPC::Message> pending_input_event_ack_; // The time spent in input handlers this frame. Used to throttle input acks. base::TimeDelta total_input_handling_time_this_frame_; // Indicates if the next sequence of Char events should be suppressed or not. bool suppress_next_char_events_; // Properties of the screen hosting this RenderWidget instance. blink::WebScreenInfo screen_info_; // The device scale factor. This value is computed from the DPI entries in // |screen_info_| on some platforms, and defaults to 1 on other platforms. float device_scale_factor_; // The device color profile on supported platforms. std::vector<char> device_color_profile_; // State associated with synthetic gestures. Synthetic gestures are processed // in-order, so a queue is sufficient to identify the correct state for a // completed gesture. std::queue<SyntheticGestureCompletionCallback> pending_synthetic_gesture_callbacks_; // Specified whether the compositor will run in its own thread. bool is_threaded_compositing_enabled_; const ui::LatencyInfo* current_event_latency_info_; uint32 next_output_surface_id_; #if defined(OS_ANDROID) // Indicates value in the focused text field is in dirty state, i.e. modified // by script etc., not by user input. bool text_field_is_dirty_; // A counter for number of outstanding messages from the renderer to the // browser regarding IME-type events that have not been acknowledged by the // browser. If this value is not 0 IME events will be dropped. int outstanding_ime_acks_; // The background color of the document body element. This is used as the // default background color for filling the screen areas for which we don't // have the actual content. SkColor body_background_color_; #endif scoped_ptr<ScreenMetricsEmulator> screen_metrics_emulator_; // Popups may be displaced when screen metrics emulation is enabled. // These values are used to properly adjust popup position. gfx::Point popup_view_origin_for_emulation_; gfx::Point popup_screen_origin_for_emulation_; float popup_origin_scale_for_emulation_; scoped_ptr<ResizingModeSelector> resizing_mode_selector_; // Lists of RenderFrameProxy objects that need to be notified of // compositing-related events (e.g. DidCommitCompositorFrame). ObserverList<RenderFrameProxy> render_frame_proxies_; #if defined(VIDEO_HOLE) ObserverList<RenderFrameImpl> video_hole_frames_; #endif // defined(VIDEO_HOLE) // A list of RenderFrames associated with this RenderWidget. Notifications // are sent to each frame in the list for events such as changing // visibility state for example. ObserverList<RenderFrameImpl> render_frames_; ui::MenuSourceType context_menu_source_type_; bool has_host_context_menu_location_; gfx::Point host_context_menu_location_; DISALLOW_COPY_AND_ASSIGN(RenderWidget); }; } // namespace content #endif // CONTENT_RENDERER_RENDER_WIDGET_H_