Update To 11.40.268.0
[platform/framework/web/crosswalk.git] / src / content / renderer / browser_plugin / browser_plugin.h
index 008964e..d072e7b 100644 (file)
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/weak_ptr.h"
 #include "base/sequenced_task_runner_helpers.h"
-#if defined(OS_WIN)
-#include "base/memory/shared_memory.h"
-#endif
-#include "base/values.h"
-#include "content/renderer/browser_plugin/browser_plugin_backing_store.h"
-#include "content/renderer/browser_plugin/browser_plugin_bindings.h"
 #include "content/renderer/mouse_lock_dispatcher.h"
 #include "content/renderer/render_view_impl.h"
 #include "third_party/WebKit/public/web/WebCompositionUnderline.h"
 #include "third_party/WebKit/public/web/WebDragStatus.h"
+#include "third_party/WebKit/public/web/WebNode.h"
 #include "third_party/WebKit/public/web/WebWidget.h"
 
-struct BrowserPluginHostMsg_AutoSize_Params;
 struct BrowserPluginHostMsg_ResizeGuest_Params;
-struct BrowserPluginMsg_Attach_ACK_Params;
-struct BrowserPluginMsg_UpdateRect_Params;
 struct FrameMsg_BuffersSwapped_Params;
 
 namespace content {
 
+class BrowserPluginDelegate;
 class ChildFrameCompositingHelper;
 class BrowserPluginManager;
 class MockBrowserPlugin;
@@ -38,105 +31,43 @@ class CONTENT_EXPORT BrowserPlugin :
     NON_EXPORTED_BASE(public blink::WebPlugin),
     public MouseLockDispatcher::LockTarget {
  public:
+  static BrowserPlugin* GetFromNode(blink::WebNode& node);
+
   RenderViewImpl* render_view() const { return render_view_.get(); }
   int render_view_routing_id() const { return render_view_routing_id_; }
-  int guest_instance_id() const { return guest_instance_id_; }
+  int browser_plugin_instance_id() const { return browser_plugin_instance_id_; }
   bool attached() const { return attached_; }
-
-  static BrowserPlugin* FromContainer(blink::WebPluginContainer* container);
+  bool ready() const { return attached_ || attach_pending_; }
+  BrowserPluginManager* browser_plugin_manager() const {
+    return browser_plugin_manager_.get();
+  }
 
   bool OnMessageReceived(const IPC::Message& msg);
 
   // Update Browser Plugin's DOM Node attribute |attribute_name| with the value
   // |attribute_value|.
   void UpdateDOMAttribute(const std::string& attribute_name,
-                          const std::string& attribute_value);
-  // Remove the DOM Node attribute with the name |attribute_name|.
-  void RemoveDOMAttribute(const std::string& attribute_name);
-  // Get Browser Plugin's DOM Node attribute |attribute_name|'s value.
-  std::string GetDOMAttributeValue(const std::string& attribute_name) const;
-  // Checks if the attribute |attribute_name| exists in the DOM.
-  bool HasDOMAttribute(const std::string& attribute_name) const;
-
-  // Get the name attribute value.
-  std::string GetNameAttribute() const;
-  // Parse the name attribute value.
-  void ParseNameAttribute();
-  // Get the allowtransparency attribute value.
-  bool GetAllowTransparencyAttribute() const;
-  // Parse the allowtransparency attribute and adjust transparency of
-  // BrowserPlugin accordingly.
-  void ParseAllowTransparencyAttribute();
-  // Get the src attribute value of the BrowserPlugin instance.
-  std::string GetSrcAttribute() const;
-  // Parse the src attribute value of the BrowserPlugin instance.
-  bool ParseSrcAttribute(std::string* error_message);
-  // Get the autosize attribute value.
-  bool GetAutoSizeAttribute() const;
-  // Parses the autosize attribute value.
-  void ParseAutoSizeAttribute();
-  // Get the maxheight attribute value.
-  int GetMaxHeightAttribute() const;
-  // Get the maxwidth attribute value.
-  int GetMaxWidthAttribute() const;
-  // Get the minheight attribute value.
-  int GetMinHeightAttribute() const;
-  // Get the minwidth attribute value.
-  int GetMinWidthAttribute() const;
-  // Parse the minwidth, maxwidth, minheight, and maxheight attribute values.
-  void ParseSizeContraintsChanged();
-  // The partition identifier string is stored as UTF-8.
-  std::string GetPartitionAttribute() const;
-  // This method can be successfully called only before the first navigation for
-  // this instance of BrowserPlugin. If an error occurs, the |error_message| is
-  // set appropriately to indicate the failure reason.
-  bool ParsePartitionAttribute(std::string* error_message);
-  // True if the partition attribute can be removed.
-  bool CanRemovePartitionAttribute(std::string* error_message);
-
-  bool InAutoSizeBounds(const gfx::Size& size) const;
-
-  // Get the guest's DOMWindow proxy.
-  NPObject* GetContentWindow() const;
+                          const base::string16& attribute_value);
 
   // Returns whether the guest process has crashed.
   bool guest_crashed() const { return guest_crashed_; }
-  // Returns whether this BrowserPlugin has requested an instance ID.
-  bool HasNavigated() const;
-  // Returns whether this BrowserPlugin has allocated an instance ID.
-  bool HasGuestInstanceID() const;
-
-  // Attaches the window identified by |window_id| to the the given node
-  // encapsulating a BrowserPlugin.
-  static bool AttachWindowTo(const blink::WebNode& node,
-                             int window_id);
 
   // Informs the guest of an updated focus state.
   void UpdateGuestFocusState();
+
   // Indicates whether the guest should be focused.
   bool ShouldGuestBeFocused() const;
 
   // Embedder's device scale factor changed, we need to update the guest
   // renderer.
-  void UpdateDeviceScaleFactor(float device_scale_factor);
+  void UpdateDeviceScaleFactor();
 
   // A request to enable hardware compositing.
   void EnableCompositing(bool enable);
 
-  // Returns true if |point| lies within the bounds of the plugin rectangle.
-  // Not OK to use this function for making security-sensitive decision since it
-  // can return false positives when the plugin has rotation transformation
-  // applied.
-  bool InBounds(const gfx::Point& point) const;
-
-  gfx::Point ToLocalCoordinates(const gfx::Point& point) const;
-
-  // Called when a guest instance ID has been allocated by the browser process.
-  void OnInstanceIDAllocated(int guest_instance_id);
   // Provided that a guest instance ID has been allocated, this method attaches
-  // this BrowserPlugin instance to that guest. |extra_params| are parameters
-  // passed in by the content embedder to the browser process.
-  void Attach(scoped_ptr<base::DictionaryValue> extra_params);
+  // this BrowserPlugin instance to that guest.
+  void Attach();
 
   // Notify the plugin about a compositor commit so that frame ACKs could be
   // sent, if needed.
@@ -146,70 +77,66 @@ class CONTENT_EXPORT BrowserPlugin :
   static bool ShouldForwardToBrowserPlugin(const IPC::Message& message);
 
   // blink::WebPlugin implementation.
-  virtual blink::WebPluginContainer* container() const OVERRIDE;
-  virtual bool initialize(blink::WebPluginContainer* container) OVERRIDE;
-  virtual void destroy() OVERRIDE;
-  virtual NPObject* scriptableObject() OVERRIDE;
-  virtual struct _NPP* pluginNPP() OVERRIDE;
-  virtual bool supportsKeyboardFocus() const OVERRIDE;
-  virtual bool supportsEditCommands() const OVERRIDE;
-  virtual bool supportsInputMethod() const OVERRIDE;
-  virtual bool canProcessDrag() const OVERRIDE;
+  virtual blink::WebPluginContainer* container() const override;
+  virtual bool initialize(blink::WebPluginContainer* container) override;
+  virtual void destroy() override;
+  virtual bool supportsKeyboardFocus() const override;
+  virtual bool supportsEditCommands() const override;
+  virtual bool supportsInputMethod() const override;
+  virtual bool canProcessDrag() const override;
   virtual void paint(
       blink::WebCanvas* canvas,
-      const blink::WebRect& rect) OVERRIDE;
+      const blink::WebRect& rect) override;
   virtual void updateGeometry(
       const blink::WebRect& frame_rect,
       const blink::WebRect& clip_rect,
       const blink::WebVector<blink::WebRect>& cut_outs_rects,
-      bool is_visible) OVERRIDE;
-  virtual void updateFocus(bool focused) OVERRIDE;
-  virtual void updateVisibility(bool visible) OVERRIDE;
-  virtual bool acceptsInputEvents() OVERRIDE;
+      bool is_visible) override;
+  virtual void updateFocus(bool focused) override;
+  virtual void updateVisibility(bool visible) override;
+  virtual bool acceptsInputEvents() override;
   virtual bool handleInputEvent(
       const blink::WebInputEvent& event,
-      blink::WebCursorInfo& cursor_info) OVERRIDE;
+      blink::WebCursorInfo& cursor_info) override;
   virtual bool handleDragStatusUpdate(blink::WebDragStatus drag_status,
                                       const blink::WebDragData& drag_data,
                                       blink::WebDragOperationsMask mask,
                                       const blink::WebPoint& position,
-                                      const blink::WebPoint& screen) OVERRIDE;
+                                      const blink::WebPoint& screen) override;
   virtual void didReceiveResponse(
-      const blink::WebURLResponse& response) OVERRIDE;
-  virtual void didReceiveData(const char* data, int data_length) OVERRIDE;
-  virtual void didFinishLoading() OVERRIDE;
-  virtual void didFailLoading(const blink::WebURLError& error) OVERRIDE;
+      const blink::WebURLResponse& response) override;
+  virtual void didReceiveData(const char* data, int data_length) override;
+  virtual void didFinishLoading() override;
+  virtual void didFailLoading(const blink::WebURLError& error) override;
   virtual void didFinishLoadingFrameRequest(
       const blink::WebURL& url,
-      void* notify_data) OVERRIDE;
+      void* notify_data) override;
   virtual void didFailLoadingFrameRequest(
       const blink::WebURL& url,
       void* notify_data,
-      const blink::WebURLError& error) OVERRIDE;
-  virtual bool executeEditCommand(const blink::WebString& name) OVERRIDE;
+      const blink::WebURLError& error) override;
+  virtual bool executeEditCommand(const blink::WebString& name) override;
   virtual bool executeEditCommand(const blink::WebString& name,
-                                  const blink::WebString& value) OVERRIDE;
+                                  const blink::WebString& value) override;
   virtual bool setComposition(
       const blink::WebString& text,
       const blink::WebVector<blink::WebCompositionUnderline>& underlines,
       int selectionStart,
-      int selectionEnd) OVERRIDE;
+      int selectionEnd) override;
   virtual bool confirmComposition(
       const blink::WebString& text,
-      blink::WebWidget::ConfirmCompositionBehavior selectionBehavior) OVERRIDE;
-  virtual void extendSelectionAndDelete(int before, int after) OVERRIDE;
+      blink::WebWidget::ConfirmCompositionBehavior selectionBehavior) override;
+  virtual void extendSelectionAndDelete(int before, int after) override;
 
   // MouseLockDispatcher::LockTarget implementation.
-  virtual void OnLockMouseACK(bool succeeded) OVERRIDE;
-  virtual void OnMouseLockLost() OVERRIDE;
-  virtual bool HandleMouseLockedInputEvent(
-          const blink::WebMouseEvent& event) OVERRIDE;
+  void OnLockMouseACK(bool succeeded) override;
+  void OnMouseLockLost() override;
+  bool HandleMouseLockedInputEvent(const blink::WebMouseEvent& event) override;
 
  private:
   friend class base::DeleteHelper<BrowserPlugin>;
   // Only the manager is allowed to create a BrowserPlugin.
-  friend class BrowserPluginManagerImpl;
-  friend class MockBrowserPluginManager;
+  friend class BrowserPluginManager;
 
   // For unit/integration tests.
   friend class MockBrowserPlugin;
@@ -217,132 +144,57 @@ class CONTENT_EXPORT BrowserPlugin :
   // A BrowserPlugin object is a controller that represents an instance of a
   // browser plugin within the embedder renderer process. Once a BrowserPlugin
   // does an initial navigation or is attached to a newly created guest, it
-  // acquires a guest_instance_id as well. The guest instance ID uniquely
-  // identifies a guest WebContents that's hosted by this BrowserPlugin.
-  BrowserPlugin(RenderViewImpl* render_view, blink::WebFrame* frame);
+  // acquires a browser_plugin_instance_id as well. The guest instance ID
+  // uniquely identifies a guest WebContents that's hosted by this
+  // BrowserPlugin.
+  BrowserPlugin(RenderViewImpl* render_view,
+                blink::WebFrame* frame,
+                scoped_ptr<BrowserPluginDelegate> delegate);
 
-  virtual ~BrowserPlugin();
+  ~BrowserPlugin() override;
 
   int width() const { return plugin_rect_.width(); }
   int height() const { return plugin_rect_.height(); }
-  gfx::Rect plugin_rect() { return plugin_rect_; }
-  // Gets the Max Height value used for auto size.
-  int GetAdjustedMaxHeight() const;
-  // Gets the Max Width value used for auto size.
-  int GetAdjustedMaxWidth() const;
-  // Gets the Min Height value used for auto size.
-  int GetAdjustedMinHeight() const;
-  // Gets the Min Width value used for auto size.
-  int GetAdjustedMinWidth() const;
-  BrowserPluginManager* browser_plugin_manager() const {
-    return browser_plugin_manager_.get();
-  }
+  gfx::Size plugin_size() const { return plugin_rect_.size(); }
+  gfx::Rect plugin_rect() const { return plugin_rect_; }
 
-  // Virtual to allow for mocking in tests.
-  virtual float GetDeviceScaleFactor() const;
+  float GetDeviceScaleFactor() const;
 
   void ShowSadGraphic();
 
-  // Parses the attributes of the browser plugin from the element's attributes
-  // and sets them appropriately.
-  void ParseAttributes();
-
-  // Triggers the event-listeners for |event_name|. Note that the function
-  // frees all the values in |props|.
-  void TriggerEvent(const std::string& event_name,
-                    std::map<std::string, base::Value*>* props);
-
-  // Creates and maps a shared damage buffer.
-  virtual base::SharedMemory* CreateDamageBuffer(
-      const size_t size,
-      base::SharedMemoryHandle* shared_memory_handle);
-  // Swaps out the |current_damage_buffer_| with the |pending_damage_buffer_|.
-  void SwapDamageBuffers();
-
-  // Populates BrowserPluginHostMsg_ResizeGuest_Params with resize state and
-  // allocates a new |pending_damage_buffer_| if in software rendering mode.
+  // Populates BrowserPluginHostMsg_ResizeGuest_Params with resize state.
   void PopulateResizeGuestParameters(
-      BrowserPluginHostMsg_ResizeGuest_Params* params,
-      const gfx::Rect& view_size,
-      bool needs_repaint);
-
-  // Populates BrowserPluginHostMsg_AutoSize_Params object with autosize state.
-  void PopulateAutoSizeParameters(
-      BrowserPluginHostMsg_AutoSize_Params* params, bool auto_size_enabled);
-
-  // Populates both AutoSize and ResizeGuest parameters based on the current
-  // autosize state.
-  void GetDamageBufferWithSizeParams(
-      BrowserPluginHostMsg_AutoSize_Params* auto_size_params,
-      BrowserPluginHostMsg_ResizeGuest_Params* resize_guest_params,
-      bool needs_repaint);
-
-  // Informs the guest of an updated autosize state.
-  void UpdateGuestAutoSizeState(bool auto_size_enabled);
-
-  // Indicates whether a damage buffer was used by the guest process for the
-  // provided |params|.
-  static bool UsesDamageBuffer(
-      const BrowserPluginMsg_UpdateRect_Params& params);
-
-  // Indicates whether the |pending_damage_buffer_| was used to copy over pixels
-  // given the provided |params|.
-  bool UsesPendingDamageBuffer(
-      const BrowserPluginMsg_UpdateRect_Params& params);
+      const gfx::Size& view_size,
+      BrowserPluginHostMsg_ResizeGuest_Params* params);
 
   // IPC message handlers.
   // Please keep in alphabetical order.
   void OnAdvanceFocus(int instance_id, bool reverse);
-  void OnAttachACK(int instance_id,
-                   const BrowserPluginMsg_Attach_ACK_Params& ack_params);
-  void OnBuffersSwapped(int instance_id,
-                        const FrameMsg_BuffersSwapped_Params& params);
+  void OnAttachACK(int browser_plugin_instance_id);
   void OnCompositorFrameSwapped(const IPC::Message& message);
-  void OnCopyFromCompositingSurface(int instance_id,
-                                    int request_id,
-                                    gfx::Rect source_rect,
-                                    gfx::Size dest_size);
-  void OnGuestContentWindowReady(int instance_id,
-                                 int content_window_routing_id);
   void OnGuestGone(int instance_id);
+  void OnSetContentsOpaque(int instance_id, bool opaque);
   void OnSetCursor(int instance_id, const WebCursor& cursor);
   void OnSetMouseLock(int instance_id, bool enable);
+  void OnSetTooltipText(int browser_plugin_instance_id,
+                        const base::string16& tooltip_text);
   void OnShouldAcceptTouchEvents(int instance_id, bool accept);
-  void OnUpdatedName(int instance_id, const std::string& name);
-  void OnUpdateRect(int instance_id,
-                    const BrowserPluginMsg_UpdateRect_Params& params);
 
-  // This is the browser-process-allocated instance ID that uniquely identifies
-  // a guest WebContents.
-  int guest_instance_id_;
   // This indicates whether this BrowserPlugin has been attached to a
   // WebContents.
   bool attached_;
-  base::WeakPtr<RenderViewImpl> render_view_;
+  bool attach_pending_;
+  const base::WeakPtr<RenderViewImpl> render_view_;
   // We cache the |render_view_|'s routing ID because we need it on destruction.
   // If the |render_view_| is destroyed before the BrowserPlugin is destroyed
   // then we will attempt to access a NULL pointer.
-  int render_view_routing_id_;
+  const int render_view_routing_id_;
   blink::WebPluginContainer* container_;
-  scoped_ptr<BrowserPluginBindings> bindings_;
-  scoped_ptr<BrowserPluginBackingStore> backing_store_;
-  scoped_ptr<base::SharedMemory> current_damage_buffer_;
-  scoped_ptr<base::SharedMemory> pending_damage_buffer_;
-  uint32 damage_buffer_sequence_id_;
-  bool paint_ack_received_;
   gfx::Rect plugin_rect_;
   float last_device_scale_factor_;
   // Bitmap for crashed plugin. Lazily initialized, non-owning pointer.
   SkBitmap* sad_guest_;
   bool guest_crashed_;
-  scoped_ptr<BrowserPluginHostMsg_ResizeGuest_Params> pending_resize_params_;
-  bool is_auto_size_state_dirty_;
-  // Maximum size constraint for autosize.
-  gfx::Size max_auto_size_;
-  std::string storage_partition_id_;
-  bool persist_storage_;
-  bool valid_partition_id_;
-  int content_window_routing_id_;
   bool plugin_focused_;
   // Tracks the visibility of the browser plugin regardless of the whole
   // embedder RenderView's visibility.
@@ -350,27 +202,29 @@ class CONTENT_EXPORT BrowserPlugin :
 
   WebCursor cursor_;
 
-  gfx::Size last_view_size_;
-  bool before_first_navigation_;
   bool mouse_locked_;
 
+  // This indicates that the BrowserPlugin has a geometry.
+  bool ready_;
+
   // BrowserPlugin outlives RenderViewImpl in Chrome Apps and so we need to
   // store the BrowserPlugin's BrowserPluginManager in a member variable to
   // avoid accessing the RenderViewImpl.
-  scoped_refptr<BrowserPluginManager> browser_plugin_manager_;
+  const scoped_refptr<BrowserPluginManager> browser_plugin_manager_;
 
   // Used for HW compositing.
-  bool compositing_enabled_;
   scoped_refptr<ChildFrameCompositingHelper> compositing_helper_;
 
-  // Used to identify the plugin to WebBindings.
-  scoped_ptr<struct _NPP> npp_;
-
   // URL for the embedder frame.
-  GURL embedder_frame_url_;
+  int browser_plugin_instance_id_;
+
+  // Indicates whether the guest content is opaque.
+  bool contents_opaque_;
 
   std::vector<EditCommand> edit_commands_;
 
+  scoped_ptr<BrowserPluginDelegate> delegate_;
+
   // Weak factory used in v8 |MakeWeak| callback, since the v8 callback might
   // get called after BrowserPlugin has been destroyed.
   base::WeakPtrFactory<BrowserPlugin> weak_ptr_factory_;