Browser Plugin: New Implementation (Renderer Side)

content/common/browser_plugin_messages.h

+// 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.
+
+// Multiply-included message header, no traditional include guard.
+
+#include <string>
+
+#include "base/basictypes.h"
+#include "base/process.h"
+#include "content/common/content_export.h"
+#include "content/public/common/common_param_traits.h"
+#include "ipc/ipc_channel_handle.h"
+#include "ipc/ipc_message_macros.h"
+#include "ipc/ipc_message_utils.h"
+#include "ui/gfx/rect.h"
+#include "ui/gfx/size.h"
+#include "webkit/glue/webcursor.h"
+
+#undef IPC_MESSAGE_EXPORT
+#define IPC_MESSAGE_EXPORT CONTENT_EXPORT
+
+#define IPC_MESSAGE_START BrowserPluginMsgStart
+
+// Browser plugin messages
+
+// -----------------------------------------------------------------------------
+// These messages are from the embedder to the browser process

[Charlie Reis, 2012/08/01 23:20:51]

nit: End with period.  Same below.

[Fady Samuel, 2012/08/02 18:32:47]

Done.

+
+IPC_STRUCT_BEGIN(BrowserPluginHostMsg_PostMessage_Params)

[Charlie Reis, 2012/08/01 23:20:51]

Why does this need to be duplicated from ViewMsg_PostMessage_Params?

[Fady Samuel, 2012/08/02 18:32:47]

Short answer: Badness happens when I try to access anything in view_messages.h
from here: it doesn't compile. Maybe I didn't try hard enough to make it work,
though.

[Charlie Reis, 2012/08/03 18:06:02]

Ok.  I'm guessing we'll need to tweak the parameters on this message anyway.

+  // The serialized script value.
+  IPC_STRUCT_MEMBER(string16, data)
+
+  // This is the routing ID of the source frame in the source process.  The
+  // browser replaces it with the routing ID of the equivalent (swapped out)
+  // frame in the destination process.
+  IPC_STRUCT_MEMBER(int, source_routing_id)
+
+  // The origin of the source frame.
+  IPC_STRUCT_MEMBER(string16, source_origin)
+
+  // The origin for the message's target.
+  IPC_STRUCT_MEMBER(string16, target_origin)
+IPC_STRUCT_END()
+
+IPC_MESSAGE_ROUTED1(BrowserPluginHostMsg_RouteMessageEvent,
+                    BrowserPluginHostMsg_PostMessage_Params)
+
+// Tells the guest to focus or defocus itself.
+IPC_MESSAGE_ROUTED2(BrowserPluginHostMsg_SetFocus,
+                    int /* instance_id */,
+                    bool /* enable */)
+
+// Message payload includes:
+// 1. A blob that should be cast to WebInputEvent
+// 2. An optional boolean value indicating if a RawKeyDown event is associated
+//    to a keyboard shortcut of the browser.
+IPC_SYNC_MESSAGE_ROUTED0_2(BrowserPluginHostMsg_HandleInputEvent,
+                           bool /* handled */,
+                           WebCursor /* cursor */)
+
+// An ACK to the guest process letting it know that the embedder has handled
+// the previous frame and is ready for the next frame. If the guest sent the
+// embedder a bitmap that does not match the size of the BrowserPlugin's
+// container, the BrowserPlugin requests a new size as well.
+IPC_MESSAGE_ROUTED3(BrowserPluginHostMsg_UpdateRect_ACK,
+                    int /* instance_id */,
+                    int /* message_id */,
+                    gfx::Size /* repaint_view_size */)
+
+// A renderer sends this to the browser process when it wants to
+// create a browser plugin.  The browser will a guest renderer process

[Charlie Reis, 2012/08/01 23:20:51]

nit: The browser will create

The comment makes this sound like a request to create, but the message name
sounds like a request to navigate, which could create a guest or work within an
existing one.  Is this intended to serve both roles?  Please update the comment
if so.

[Fady Samuel, 2012/08/02 18:32:47]

Agreed, this is very confusing and this is not a good comment. I renamed this
BrowserPluginHostMsg_NavigateOrCreateGuest and updated the comment
appropriately. Thanks.

[Charlie Reis, 2012/08/03 18:06:02]

The comment is much better, thanks.  I'd recommend
BrowserPluginHostMsg_NavigateGuest as the message name, since it currently
sounds like it will either navigate or create (perhaps based on a parameter). 
The comment makes it clear that the guest will be created if necessary.

+// if necessary.
+IPC_MESSAGE_ROUTED3(BrowserPluginHostMsg_NavigateFromEmbedder,
+                    int /* instance_id*/,
+                    long long /* frame_id */,
+                    std::string /* src */)
+
+// When a BrowserPlugin has been removed from the embedder's DOM, it informs
+// the browser process to cleanup the guest.
+IPC_MESSAGE_ROUTED1(BrowserPluginHostMsg_PluginDestroyed,
+                    int /* instance_id */)
+
+// -----------------------------------------------------------------------------
+// These messages are from the guest renderer to the browser process
+
+// A embedder sends this message to the browser when it wants
+// to resize a guest plugin container so that the guest is relaid out
+// according to the new size.
+IPC_SYNC_MESSAGE_ROUTED5_0(BrowserPluginHostMsg_ResizeGuest,
+                           int /* instance_id*/,
+                           TransportDIB::Id /* damage_buffer_id */,
+                           int /* width */,
+                           int  /* height */,
+                           bool /* resize_pending */)
+
+// -----------------------------------------------------------------------------
+// These messages are from the browser process to the embedder.
+
+// When the guest navigates, the browser process informs the embedder through
+// the BrowserPluginMsg_UpdateURL message.

[Charlie Reis, 2012/08/01 23:20:51]

Why does the embedder need to know?  Just to expose it as an event via an API?

[Fady Samuel, 2012/08/02 18:32:47]

Mihai wrote a small browser demo with the browser tag, but the URL bar did not
update on guest-initiated navigation. I added this to fill that obvious gap in
functionality.

+IPC_MESSAGE_CONTROL2(BrowserPluginMsg_UpdateURL,
+                     int /* instance_id */,
+                     GURL /* url */)
+
+// When the guest crashes, the browser process informs the embedder through this
+// message.
+IPC_MESSAGE_CONTROL1(BrowserPluginMsg_GuestCrashed,
+                     int /* instance_id */)
+
+IPC_STRUCT_BEGIN(BrowserPluginMsg_UpdateRect_Params)
+  // The position and size of the bitmap.
+  IPC_STRUCT_MEMBER(gfx::Rect, bitmap_rect)
+
+  // The scroll offset.  Only one of these can be non-zero, and if they are
+  // both zero, then it means there is no scrolling and the scroll_rect is
+  // ignored.
+  IPC_STRUCT_MEMBER(int, dx)
+  IPC_STRUCT_MEMBER(int, dy)
+
+  // The rectangular region to scroll.
+  IPC_STRUCT_MEMBER(gfx::Rect, scroll_rect)
+
+  // The scroll offset of the render view.
+  IPC_STRUCT_MEMBER(gfx::Point, scroll_offset)
+
+  // The regions of the bitmap (in view coords) that contain updated pixels.
+  // In the case of scrolling, this includes the scroll damage rect.
+  IPC_STRUCT_MEMBER(std::vector<gfx::Rect>, copy_rects)
+
+  // The size of the RenderView when this message was generated.  This is
+  // included so the host knows how large the view is from the perspective of
+  // the renderer process.  This is necessary in case a resize operation is in
+  // progress. If auto-resize is enabled, this should update the corresponding
+  // view size.
+  IPC_STRUCT_MEMBER(gfx::Size, view_size)
+
+  // All the above coordinates are in DIP. This is the scale factor needed
+  // to convert them to pixels.
+  IPC_STRUCT_MEMBER(float, scale_factor)
+
+  // Is this UpdateRect an ACK to a resize request?
+  IPC_STRUCT_MEMBER(bool, is_resize_ack)
+IPC_STRUCT_END()
+
+// When the user tabs to the end of the tab stops of a guest, the browser
+// process informs the embedder to tab out of the browser plugin.
+IPC_MESSAGE_CONTROL2(BrowserPluginMsg_AdvanceFocus,
+                     int /* instance_id */,
+                     bool /* reverse */)
+
+// The guest has damage it wants to convey to the embedder so that it can
+// update its backing store.
+IPC_MESSAGE_CONTROL3(BrowserPluginMsg_UpdateRect,
+                     int /* instance_id */,
+                     int /* message_id */,
+                     BrowserPluginMsg_UpdateRect_Params)