diff options
Diffstat (limited to 'content/browser/renderer_host/render_widget_host.h')
| -rw-r--r-- | content/browser/renderer_host/render_widget_host.h | 289 |
1 files changed, 4 insertions, 285 deletions
diff --git a/content/browser/renderer_host/render_widget_host.h b/content/browser/renderer_host/render_widget_host.h index 8e7863b..9351c693 100644 --- a/content/browser/renderer_host/render_widget_host.h +++ b/content/browser/renderer_host/render_widget_host.h @@ -19,28 +19,13 @@ #include "base/string16.h" #include "base/timer.h" #include "build/build_config.h" -#include "content/common/content_export.h" -#include "content/public/browser/native_web_keyboard_event.h" +#include "content/public/browser/render_widget_host.h" #include "content/public/common/page_zoom.h" -#include "ipc/ipc_channel.h" -#include "third_party/WebKit/Source/WebKit/chromium/public/WebInputEvent.h" -#include "third_party/WebKit/Source/WebKit/chromium/public/WebTextDirection.h" #include "ui/base/ime/text_input_type.h" #include "ui/gfx/native_widget_types.h" -#include "ui/gfx/size.h" -#include "ui/gfx/surface/transport_dib.h" - -#if defined(TOOLKIT_GTK) -#include "ui/base/x/x11_util.h" -#elif defined(OS_MACOSX) -#include "skia/ext/platform_device.h" -#endif class BackingStore; struct EditCommand; -class RenderViewHost; -class RenderWidgetHostImpl; -class TransportDIB; struct ViewHostMsg_UpdateRect_Params; class WebCursor; @@ -49,19 +34,9 @@ class TimeTicks; } namespace content { -class RenderProcessHost; -class RenderWidgetHostView; class RenderWidgetHostViewPort; } -namespace gfx { -class Rect; -} - -namespace skia { -class PlatformCanvas; -} - namespace ui { class Range; } @@ -73,268 +48,12 @@ struct WebCompositionUnderline; struct WebScreenInfo; } -// TODO(joi): Extract relevant bit of class documentation from -// RenderWidgetHostImpl documentation. TODO(joi): Move to -// content/public/browser/render_widget_host.h +// This implements the RenderWidgetHost interface that is exposed to +// embedders of content, and adds things only visible to content. // -// TODO(joi): Once I finish defining this interface (once -// RenderViewHost interface is also in place), group together -// implementation functions in subclasses. +// TODO(joi): Move to content namespace. // // TODO(joi): Move to file render_widget_host_impl.h -class CONTENT_EXPORT RenderWidgetHost : public IPC::Channel::Sender { - public: - virtual ~RenderWidgetHost() {} - - // Edit operations. - virtual void Undo() = 0; - virtual void Redo() = 0; - virtual void Cut() = 0; - virtual void Copy() = 0; - virtual void CopyToFindPboard() = 0; - virtual void Paste() = 0; - virtual void PasteAndMatchStyle() = 0; - virtual void Delete() = 0; - virtual void SelectAll() = 0; - - // Update the text direction of the focused input element and notify it to a - // renderer process. - // These functions have two usage scenarios: changing the text direction - // from a menu (as Safari does), and; changing the text direction when a user - // presses a set of keys (as IE and Firefox do). - // 1. Change the text direction from a menu. - // In this scenario, we receive a menu event only once and we should update - // the text direction immediately when a user chooses a menu item. So, we - // should call both functions at once as listed in the following snippet. - // void RenderViewHost::SetTextDirection(WebTextDirection direction) { - // UpdateTextDirection(direction); - // NotifyTextDirection(); - // } - // 2. Change the text direction when pressing a set of keys. - // Because of auto-repeat, we may receive the same key-press event many - // times while we presses the keys and it is nonsense to send the same IPC - // message every time when we receive a key-press event. - // To suppress the number of IPC messages, we just update the text direction - // when receiving a key-press event and send an IPC message when we release - // the keys as listed in the following snippet. - // if (key_event.type == WebKeyboardEvent::KEY_DOWN) { - // if (key_event.windows_key_code == 'A' && - // key_event.modifiers == WebKeyboardEvent::CTRL_KEY) { - // UpdateTextDirection(dir); - // } else { - // CancelUpdateTextDirection(); - // } - // } else if (key_event.type == WebKeyboardEvent::KEY_UP) { - // NotifyTextDirection(); - // } - // Once we cancel updating the text direction, we have to ignore all - // succeeding UpdateTextDirection() requests until calling - // NotifyTextDirection(). (We may receive keydown events even after we - // canceled updating the text direction because of auto-repeat.) - // Note: we cannot undo this change for compatibility with Firefox and IE. - virtual void UpdateTextDirection(WebKit::WebTextDirection direction) = 0; - virtual void NotifyTextDirection() = 0; - - virtual void Blur() = 0; - - // Copies the contents of the backing store into the given (uninitialized) - // PlatformCanvas. Returns true on success, false otherwise. - virtual bool CopyFromBackingStore(skia::PlatformCanvas* output) = 0; - -#if defined(TOOLKIT_GTK) - // Paint the backing store into the target's |dest_rect|. - virtual bool CopyFromBackingStoreToGtkWindow(const gfx::Rect& dest_rect, - GdkWindow* target) = 0; -#elif defined(OS_MACOSX) - virtual gfx::Size GetBackingStoreSize() = 0; - virtual bool CopyFromBackingStoreToCGContext(const CGRect& dest_rect, - CGContextRef target) = 0; -#endif - - // Enable renderer accessibility. This should only be called when a - // screenreader is detected. - virtual void EnableRendererAccessibility() = 0; - - // Forwards the given message to the renderer. These are called by - // the view when it has received a message. - virtual void ForwardMouseEvent( - const WebKit::WebMouseEvent& mouse_event) = 0; - virtual void ForwardWheelEvent( - const WebKit::WebMouseWheelEvent& wheel_event) = 0; - virtual void ForwardKeyboardEvent( - const NativeWebKeyboardEvent& key_event) = 0; - - virtual const gfx::Point& GetLastScrollOffset() const = 0; - - virtual content::RenderProcessHost* GetProcess() const = 0; - - virtual int GetRoutingID() const = 0; - - // Gets the View of this RenderWidgetHost. Can be NULL, e.g. if the - // RenderWidget is being destroyed or the render process crashed. You should - // never cache this pointer since it can become NULL if the renderer crashes, - // instead you should always ask for it using the accessor. - virtual content::RenderWidgetHostView* GetView() const = 0; - - // Returns true if this is a RenderViewHost, false if not. - virtual bool IsRenderView() const = 0; - - // Used as the details object for a - // RENDER_WIDGET_HOST_DID_RECEIVE_PAINT_AT_SIZE_ACK notification. - // TODO(joi): Switch out for a std::pair. - struct PaintAtSizeAckDetails { - // The tag that was passed to the PaintAtSize() call that triggered this - // ack. - int tag; - gfx::Size size; - }; - - // This tells the renderer to paint into a bitmap and return it, - // regardless of whether the tab is hidden or not. It resizes the - // web widget to match the |page_size| and then returns the bitmap - // scaled so it matches the |desired_size|, so that the scaling - // happens on the rendering thread. When the bitmap is ready, the - // renderer sends a PaintAtSizeACK to this host, and a - // RENDER_WIDGET_HOST_DID_RECEIVE_PAINT_AT_SIZE_ACK notification is issued. - // Note that this bypasses most of the update logic that is normally invoked, - // and doesn't put the results into the backing store. - virtual void PaintAtSize(TransportDIB::Handle dib_handle, - int tag, - const gfx::Size& page_size, - const gfx::Size& desired_size) = 0; - - // Makes an IPC call to tell webkit to replace the currently selected word - // or a word around the cursor. - virtual void Replace(const string16& word) = 0; - - // Called to notify the RenderWidget that the resize rect has changed without - // the size of the RenderWidget itself changing. - virtual void ResizeRectChanged(const gfx::Rect& new_rect) = 0; - - // Restart the active hang monitor timeout. Clears all existing timeouts and - // starts with a new one. This can be because the renderer has become - // active, the tab is being hidden, or the user has chosen to wait some more - // to give the tab a chance to become active and we don't want to display a - // warning too soon. - virtual void RestartHangMonitorTimeout() = 0; - - virtual void SetIgnoreInputEvents(bool ignore_input_events) = 0; - - // Stops loading the page. - virtual void Stop() = 0; - - // Called to notify the RenderWidget that it has been resized. - virtual void WasResized() = 0; - - // Access to the implementation's - // IPC::Channel::Listener::OnMessageReceived. Intended only for - // test code. - - // TODO(joi): Remove this and convert the single test using it to - // get the TabContentsWrapper from - // browser()->GetSelectedWebContents() and then call its - // translate_tab_helper() to get at the object that dispatches its - // method. - virtual bool OnMessageReceivedForTesting(const IPC::Message& msg) = 0; - - // Gets a RenderVidgetHost pointer from an IPC::Channel::Listener pointer. - static RenderWidgetHost* FromIPCChannelListener( - IPC::Channel::Listener* listener); - static const RenderWidgetHost* FromIPCChannelListener( - const IPC::Channel::Listener* listener); - - // Free all backing stores used for rendering to drop memory usage. - static void RemoveAllBackingStores(); - - // Returns the size of all the backing stores used for rendering - static size_t BackingStoreMemorySize(); - - protected: - friend class RenderWidgetHostImpl; - - // Retrieves the implementation class. Intended only for code - // within content/. This method is necessary because - // RenderWidgetHost is the root of a diamond inheritance pattern, so - // subclasses inherit it virtually, which removes our ability to - // static_cast to the subclass. - virtual RenderWidgetHostImpl* AsRenderWidgetHostImpl() = 0; -}; - -// This class manages the browser side of a browser<->renderer HWND connection. -// The HWND lives in the browser process, and windows events are sent over -// IPC to the corresponding object in the renderer. The renderer paints into -// shared memory, which we transfer to a backing store and blit to the screen -// when Windows sends us a WM_PAINT message. -// -// How Shutdown Works -// -// There are two situations in which this object, a RenderWidgetHost, can be -// instantiated: -// -// 1. By a TabContents as the communication conduit for a rendered web page. -// The TabContents instantiates a derived class: RenderViewHost. -// 2. By a TabContents as the communication conduit for a select widget. The -// TabContents instantiates the RenderWidgetHost directly. -// -// For every TabContents there are several objects in play that need to be -// properly destroyed or cleaned up when certain events occur. -// -// - TabContents - the TabContents itself, and its associated HWND. -// - RenderViewHost - representing the communication conduit with the child -// process. -// - RenderWidgetHostView - the view of the web page content, message handler, -// and plugin root. -// -// Normally, the TabContents contains a child RenderWidgetHostView that renders -// the contents of the loaded page. It has a WS_CLIPCHILDREN style so that it -// does no painting of its own. -// -// The lifetime of the RenderWidgetHostView is tied to the render process. If -// the render process dies, the RenderWidgetHostView goes away and all -// references to it must become NULL. If the TabContents finds itself without a -// RenderWidgetHostView, it paints Sad Tab instead. -// -// RenderViewHost (a RenderWidgetHost subclass) is the conduit used to -// communicate with the RenderView and is owned by the TabContents. If the -// render process crashes, the RenderViewHost remains and restarts the render -// process if needed to continue navigation. -// -// The TabContents is itself owned by the NavigationController in which it -// resides. -// -// Some examples of how shutdown works: -// -// When a tab is closed (either by the user, the web page calling window.close, -// etc) the TabStrip destroys the associated NavigationController, which calls -// Destroy on each TabContents it owns. -// -// For a TabContents, its Destroy method tells the RenderViewHost to -// shut down the render process and die. -// -// When the render process is destroyed it destroys the View: the -// RenderWidgetHostView, which destroys its HWND and deletes that object. -// -// For select popups, the situation is a little different. The RenderWidgetHost -// associated with the select popup owns the view and itself (is responsible -// for destroying itself when the view is closed). The TabContents's only -// responsibility is to select popups is to create them when it is told to. When -// the View is destroyed via an IPC message (for when WebCore destroys the -// popup, e.g. if the user selects one of the options), or because -// WM_CANCELMODE is received by the view, the View schedules the destruction of -// the render process. However in this case since there's no TabContents -// container, when the render process is destroyed, the RenderWidgetHost just -// deletes itself, which is safe because no one else should have any references -// to it (the TabContents does not). -// -// It should be noted that the RenderViewHost, not the RenderWidgetHost, -// handles IPC messages relating to the render process going away, since the -// way a RenderViewHost (TabContents) handles the process dying is different to -// the way a select popup does. As such the RenderWidgetHostView handles these -// messages for select popups. This placement is more out of convenience than -// anything else. When the view is live, these messages are forwarded to it by -// the RenderWidgetHost's IPC message map. -// -// TODO(joi): Move to content namespace. class CONTENT_EXPORT RenderWidgetHostImpl : virtual public RenderWidgetHost, public IPC::Channel::Listener { public: |