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

webkit/plugins/ppapi/ppapi_plugin_instance.h

 // 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.
 
 #ifndef WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_
 #define WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_
 
 #include <map>
 #include <set>
 #include <string>
@@ skipping 35 matching lines @@
 namespace WebKit {
 struct WebCursorInfo;
 class WebInputEvent;
 class WebPluginContainer;
 }
 
 namespace webkit {
 namespace ppapi {
 
 class FullscreenContainer;
+class MessageChannel;
 class ObjectVar;
 class PluginDelegate;
 class PluginModule;
 class PluginObject;
 class PPB_Graphics2D_Impl;
 class PPB_ImageData_Impl;
 class PPB_Surface3D_Impl;
 class PPB_URLLoader_Impl;
 class Resource;
 
 // Represents one time a plugin appears on one web page.
 //
 // Note: to get from a PP_Instance to a PluginInstance*, use the
 // ResourceTracker.
 class PluginInstance : public base::RefCounted<PluginInstance> {
  public:
+  enum InterfaceOwner {
+    BROWSER_OWNS_INTERFACE,
+    PLUGIN_OWNS_INTERFACE
+  };
+
   PluginInstance(PluginDelegate* delegate,
                  PluginModule* module,
-                 const PPP_Instance* instance_interface);
+                 const PPP_Instance* instance_interface,
+                 InterfaceOwner ppp_instance_owner);
   ~PluginInstance();
 
-  static const PPB_Instance* GetInterface();
+  static const void* GetInterface(const std::string& interface);
 
   // Returns a pointer to the interface implementing PPB_Find that is
   // exposed to the plugin.
   static const PPB_Find_Dev* GetFindInterface();
   static const PPB_Fullscreen_Dev* GetFullscreenInterface();
   static const PPB_Zoom_Dev* GetZoomInterface();
 
   PluginDelegate* delegate() const { return delegate_; }
   PluginModule* module() const { return module_.get(); }
+  MessageChannel& message_channel() { return *message_channel_; }
 
   WebKit::WebPluginContainer* container() const { return container_; }
 
   const gfx::Rect& position() const { return position_; }
   const gfx::Rect& clip() const { return clip_; }
 
   int find_identifier() const { return find_identifier_; }
 
   void set_always_on_top(bool on_top) { always_on_top_ = on_top; }
 
@@ skipping 28 matching lines @@
   // Called when the out-of-process plugin implementing this instance crashed.
   void InstanceCrashed();
 
   // PPB_Instance implementation.
   PP_Var GetWindowObject();
   PP_Var GetOwnerElementObject();
   bool BindGraphics(PP_Resource graphics_id);
   bool full_frame() const { return full_frame_; }
   bool SetCursor(PP_CursorType_Dev type);
   PP_Var ExecuteScript(PP_Var script, PP_Var* exception);
+  void PostMessage(PP_Var message);
 
   // PPP_Instance pass-through.
   void Delete();
   bool Initialize(WebKit::WebPluginContainer* container,
                   const std::vector<std::string>& arg_names,
                   const std::vector<std::string>& arg_values,
                   bool full_frame);
   bool HandleDocumentLoad(PPB_URLLoader_Impl* loader);
   bool HandleInputEvent(const WebKit::WebInputEvent& event,
                         WebKit::WebCursorInfo* cursor_info);
+  void HandleMessage(PP_Var message);
   PP_Var GetInstanceObject();
   void ViewChanged(const gfx::Rect& position, const gfx::Rect& clip);
 
   // Notifications about focus changes, see has_webkit_focus_ below.
   void SetWebKitFocus(bool has_focus);
   void SetContentAreaFocus(bool has_focus);
 
   // Notifications that the view has rendered the page and that it has been
   // flushed to the screen. These messages are used to send Flush callbacks to
   // the plugin for DeviceContext2D.
@@ skipping 196 matching lines @@
   bool always_on_top_;
 
   // Plugin container for fullscreen mode. NULL if not in fullscreen mode. Note:
   // there is a transition state where fullscreen_container_ is non-NULL but
   // fullscreen_ is false (see above).
   FullscreenContainer* fullscreen_container_;
 
   // True if we are in fullscreen mode. Note: it is false during the transition.
   bool fullscreen_;
 
+  // The MessageChannel used to implement bidirectional postMessage for the
+  // instance.
+  scoped_ptr<MessageChannel> message_channel_;
+
   typedef std::set<PluginObject*> PluginObjectSet;
   PluginObjectSet live_plugin_objects_;
 
   // Tracks all live ObjectVars used by this module so we can map NPObjects to
   // the corresponding object. These are non-owning references.
   typedef std::map<NPObject*, ObjectVar*> NPObjectToObjectVarMap;
   NPObjectToObjectVarMap np_object_to_object_var_;
 
+  // Specifies whether the PPP_Instance interface (instance_interface_) is
+  // owned by the browser or the plug-in.  If the browser had to create it for
+  // backwards-compatibility, the browser must delete it when the instance is
+  // destroyed.  Under normal circumstances, the interface is owned by the
+  // plugin and the browser must not delete it.
+  InterfaceOwner ppp_instance_owner_;
+
   DISALLOW_COPY_AND_ASSIGN(PluginInstance);
 };
 
 }  // namespace ppapi
 }  // namespace webkit
 
 #endif  // WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_