A proposal for an initial postMessage interface. This will allow JavaScript ...

webkit/plugins/ppapi/ppapi_plugin_instance.cc

 // Copyright (c) 2011 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.
 
 #include "webkit/plugins/ppapi/ppapi_plugin_instance.h"
 
 #include "base/logging.h"
 #include "base/message_loop.h"
 #include "base/metrics/histogram.h"
 #include "base/scoped_ptr.h"
@@ skipping 24 matching lines @@
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebPluginContainer.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebRect.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebString.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebURLRequest.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebView.h"
 #include "ui/gfx/rect.h"
 #include "ui/gfx/skia_util.h"
 #include "webkit/plugins/ppapi/common.h"
 #include "webkit/plugins/ppapi/event_conversion.h"
 #include "webkit/plugins/ppapi/fullscreen_container.h"
+#include "webkit/plugins/ppapi/message_channel.h"
 #include "webkit/plugins/ppapi/plugin_delegate.h"
 #include "webkit/plugins/ppapi/plugin_module.h"
 #include "webkit/plugins/ppapi/plugin_object.h"
 #include "webkit/plugins/ppapi/ppb_buffer_impl.h"
 #include "webkit/plugins/ppapi/ppb_graphics_2d_impl.h"
 #include "webkit/plugins/ppapi/ppb_image_data_impl.h"
 #include "webkit/plugins/ppapi/ppb_surface_3d_impl.h"
 #include "webkit/plugins/ppapi/ppb_url_loader_impl.h"
 #include "webkit/plugins/ppapi/ppp_pdf.h"
 #include "webkit/plugins/ppapi/string.h"
@@ skipping 37 matching lines @@
 typedef bool (*RenderPDFPageToDCProc)(
     const unsigned char* pdf_buffer, int buffer_size, int page_number, HDC dc,
     int dpi_x, int dpi_y, int bounds_origin_x, int bounds_origin_y,
     int bounds_width, int bounds_height, bool fit_to_bounds,
     bool stretch_to_bounds, bool keep_aspect_ratio, bool center_in_bounds);
 #endif  // defined(OS_WIN)
 
 namespace {
 
 #define COMPILE_ASSERT_MATCHING_ENUM(webkit_name, np_name) \
-    COMPILE_ASSERT(int(WebCursorInfo::webkit_name) == int(np_name), \
+    COMPILE_ASSERT(static_cast<int>(WebCursorInfo::webkit_name) \
+                       == static_cast<int>(np_name), \
                    mismatching_enums)
 
 COMPILE_ASSERT_MATCHING_ENUM(TypePointer, PP_CURSORTYPE_POINTER);
 COMPILE_ASSERT_MATCHING_ENUM(TypeCross, PP_CURSORTYPE_CROSS);
 COMPILE_ASSERT_MATCHING_ENUM(TypeHand, PP_CURSORTYPE_HAND);
 COMPILE_ASSERT_MATCHING_ENUM(TypeIBeam, PP_CURSORTYPE_IBEAM);
 COMPILE_ASSERT_MATCHING_ENUM(TypeWait, PP_CURSORTYPE_WAIT);
 COMPILE_ASSERT_MATCHING_ENUM(TypeHelp, PP_CURSORTYPE_HELP);
 COMPILE_ASSERT_MATCHING_ENUM(TypeEastResize, PP_CURSORTYPE_EASTRESIZE);
 COMPILE_ASSERT_MATCHING_ENUM(TypeNorthResize, PP_CURSORTYPE_NORTHRESIZE);
@@ skipping 81 matching lines @@
 
 PP_Var ExecuteScript(PP_Instance instance_id,
                      PP_Var script,
                      PP_Var* exception) {
   PluginInstance* instance = ResourceTracker::Get()->GetInstance(instance_id);
   if (!instance)
     return PP_MakeUndefined();
   return instance->ExecuteScript(script, exception);
 }
 
+void PostMessage(PP_Instance instance_id, PP_Var message) {
+  PluginInstance* instance = ResourceTracker::Get()->GetInstance(instance_id);
+  if (!instance)
+    return;
+  instance->PostMessage(message);
+}
+
 const PPB_Instance ppb_instance = {
   &GetWindowObject,
   &GetOwnerElementObject,
   &BindGraphics,
   &IsFullFrame,
   &ExecuteScript,
+  &PostMessage
 };
 
 void NumberOfFindResultsChanged(PP_Instance instance_id,
                                 int32_t total,
                                 PP_Bool final_result) {
   PluginInstance* instance = ResourceTracker::Get()->GetInstance(instance_id);
   if (!instance)
     return;
 
   DCHECK_NE(instance->find_identifier(), -1);
@@ skipping 87 matching lines @@
 
 const PPB_Zoom_Dev ppb_zoom = {
   &ZoomChanged,
   &ZoomLimitsChanged
 };
 
 }  // namespace
 
 PluginInstance::PluginInstance(PluginDelegate* delegate,
                                PluginModule* module,
-                               const PPP_Instance* instance_interface)
+                               const PPP_Instance* instance_interface,
+                               InterfaceOwner ppp_instance_owner)
     : delegate_(delegate),
       module_(module),
       instance_interface_(instance_interface),
       pp_instance_(0),
       container_(NULL),
       full_frame_(false),
       has_webkit_focus_(false),
       has_content_area_focus_(false),
       find_identifier_(-1),
       plugin_find_interface_(NULL),
       plugin_pdf_interface_(NULL),
       plugin_selection_interface_(NULL),
       plugin_zoom_interface_(NULL),
 #if defined(OS_LINUX)
       canvas_(NULL),
 #endif  // defined(OS_LINUX)
       plugin_print_interface_(NULL),
       plugin_graphics_3d_interface_(NULL),
       always_on_top_(false),
       fullscreen_container_(NULL),
-      fullscreen_(false) {
+      fullscreen_(false),
+      message_channel_(NULL),
+      ppp_instance_owner_(ppp_instance_owner) {
   pp_instance_ = ResourceTracker::Get()->AddInstance(this);
 
   memset(&current_print_settings_, 0, sizeof(current_print_settings_));
   DCHECK(delegate);
   module_->InstanceCreated(this);
   delegate_->InstanceCreated(this);
+  message_channel_.reset(new MessageChannel(this));
 }
 
 PluginInstance::~PluginInstance() {
   // Free all the plugin objects. This will automatically clear the back-
   // pointer from the NPObject so WebKit can't call into the plugin any more.
   //
   // Swap out the set so we can delete from it (the objects will try to
   // unregister themselves inside the delete call).
   PluginObjectSet plugin_object_copy;
   live_plugin_objects_.swap(plugin_object_copy);
   for (PluginObjectSet::iterator i = plugin_object_copy.begin();
        i != plugin_object_copy.end(); ++i)
     delete *i;
 
   delegate_->InstanceDeleted(this);
   module_->InstanceDeleted(this);
 
   ResourceTracker::Get()->InstanceDeleted(pp_instance_);
 #if defined(OS_LINUX)
   ranges_.clear();
 #endif  // defined(OS_LINUX)
+
+  if (BROWSER_OWNS_INTERFACE == ppp_instance_owner_)
+    delete const_cast<PPP_Instance*>(instance_interface_);
 }
 
 // static
-const PPB_Instance* PluginInstance::GetInterface() {
-  return &ppb_instance;
+const void* PluginInstance::GetInterface(const std::string& interface) {
+  // At the time of writing, we support both 0.4 and 0.5.  But for future-
+  // proofing, we also compare to PPB_INSTANCE_INTERFACE so that we can work
+  // with later versions, assuming other parts work.  If PPB_Instance changes
+  // in a fashion that breaks the struct layout (e.g. modifying or deleting
+  // functions), this code must either get more complicated (to return a
+  // different, backwards-compatible struct) or just get rid of support for
+  // 0.4 and 0.5.
+  if ((interface == PPB_INSTANCE_INTERFACE_0_4)
+      || (interface == PPB_INSTANCE_INTERFACE_0_5)
+      || (interface == PPB_INSTANCE_INTERFACE))
+    return &ppb_instance;
+  return NULL;
 }
 
 // static
 const PPB_Find_Dev* PluginInstance::GetFindInterface() {
   return &ppb_find;
 }
 
 // static
 const PPB_Fullscreen_Dev* PluginInstance::GetFullscreenInterface() {
   return &ppb_fullscreen;
@@ skipping 202 matching lines @@
     try_catch.SetException("Exception caught");
     WebBindings::releaseVariantValue(&result);
     return PP_MakeUndefined();
   }
 
   PP_Var ret = Var::NPVariantToPPVar(this, &result);
   WebBindings::releaseVariantValue(&result);
   return ret;
 }
 
+void PluginInstance::PostMessage(PP_Var message) {
+  message_channel_->PostMessageToJavaScript(message);
+}
+
 void PluginInstance::Delete() {
   // Keep a reference on the stack. See NOTE above.
   scoped_refptr<PluginInstance> ref(this);
   instance_interface_->DidDestroy(pp_instance());
 
   if (fullscreen_container_) {
     fullscreen_container_->Destroy();
     fullscreen_container_ = NULL;
   }
   container_ = NULL;
@@ skipping 39 matching lines @@
   for (size_t i = 0; i < pp_events.size(); i++) {
     rv |= PPBoolToBool(instance_interface_->HandleInputEvent(pp_instance(),
                                                              &pp_events[i]));
   }
 
   if (cursor_.get())
     *cursor_info = *cursor_;
   return rv;
 }
 
+void PluginInstance::HandleMessage(PP_Var message) {
+  if ((instance_interface_ != NULL) &&
+      (instance_interface_->HandleMessage != NULL)) {
+    instance_interface_->HandleMessage(pp_instance(), message);
+  }
+}
+
 PP_Var PluginInstance::GetInstanceObject() {
   return instance_interface_->GetInstanceObject(pp_instance());
 }
 
 void PluginInstance::ViewChanged(const gfx::Rect& position,
                                  const gfx::Rect& clip) {
   fullscreen_ = (fullscreen_container_ != NULL);
   position_ = position;
 
   if (clip.IsEmpty()) {
@@ skipping 675 matching lines @@
   return found->second;
 }
 
 bool PluginInstance::IsFullPagePlugin() const {
   WebFrame* frame = container()->element().document().frame();
   return frame->view()->mainFrame()->document().isPluginDocument();
 }
 
 }  // namespace ppapi
 }  // namespace webkit