refactoring mouse lock to support pepper and WebKit

content/renderer/pepper_plugin_delegate_impl.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.
 
 #ifndef CONTENT_RENDERER_PEPPER_PLUGIN_DELEGATE_IMPL_H_
 #define CONTENT_RENDERER_PEPPER_PLUGIN_DELEGATE_IMPL_H_
 #pragma once
 
 #include <map>
 #include <set>
 #include <string>
 
 #include "base/basictypes.h"
 #include "base/id_map.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/weak_ptr.h"
 #include "content/common/content_export.h"
 #include "content/public/renderer/render_view_observer.h"
+#include "content/renderer/mouse_lock_dispatcher.h"
 #include "content/renderer/pepper_parent_context_provider.h"
 #include "ppapi/proxy/broker_dispatcher.h"
 #include "ppapi/proxy/proxy_channel.h"
 #include "ppapi/shared_impl/private/tcp_socket_private_impl.h"
 #include "ppapi/shared_impl/private/udp_socket_private_impl.h"
 #include "ui/base/ime/text_input_type.h"
 #include "webkit/plugins/ppapi/plugin_delegate.h"
 #include "webkit/plugins/ppapi/ppb_broker_impl.h"
 #include "webkit/plugins/ppapi/ppb_flash_menu_impl.h"
 
@@ skipping 161 matching lines @@
   bool CanComposeInline() const;
 
   // IME events.
   void OnImeSetComposition(
       const string16& text,
       const std::vector<WebKit::WebCompositionUnderline>& underlines,
       int selection_start,
       int selection_end);
   void OnImeConfirmComposition(const string16& text);
 
-  // Notification that the request to lock the mouse has completed.
-  void OnLockMouseACK(bool succeeded);
-  // Notification that the plugin instance has lost the mouse lock.
-  void OnMouseLockLost();
   // Notification that a mouse event has arrived at the render view.
-  // Returns true if no further handling is needed. For example, if the mouse is
-  // currently locked, this method directly dispatches the event to the owner of
-  // the mouse lock and returns true.
-  bool HandleMouseEvent(const WebKit::WebMouseEvent& event);
+  void WillHandleMouseEvent();
 
   // PluginDelegate implementation.
   virtual void PluginFocusChanged(webkit::ppapi::PluginInstance* instance,
                                   bool focused) OVERRIDE;
   virtual void PluginTextInputTypeChanged(
       webkit::ppapi::PluginInstance* instance) OVERRIDE;
   virtual void PluginCaretPositionChanged(
       webkit::ppapi::PluginInstance* instance) OVERRIDE;
   virtual void PluginRequestedCancelComposition(
       webkit::ppapi::PluginInstance* instance) OVERRIDE;
@@ skipping 157 matching lines @@
   virtual void DidStartLoading() OVERRIDE;
   virtual void DidStopLoading() OVERRIDE;
   virtual void SetContentRestriction(int restrictions) OVERRIDE;
   virtual void SaveURLAs(const GURL& url) OVERRIDE;
   virtual webkit_glue::P2PTransport* CreateP2PTransport() OVERRIDE;
   virtual double GetLocalTimeZoneOffset(base::Time t) OVERRIDE;
   virtual std::string GetFlashCommandLineArgs() OVERRIDE;
   virtual base::SharedMemory* CreateAnonymousSharedMemory(uint32_t size)
       OVERRIDE;
   virtual ::ppapi::Preferences GetPreferences() OVERRIDE;
-  virtual void LockMouse(webkit::ppapi::PluginInstance* instance) OVERRIDE;
+  virtual bool LockMouse(webkit::ppapi::PluginInstance* instance) OVERRIDE;
   virtual void UnlockMouse(webkit::ppapi::PluginInstance* instance) OVERRIDE;
+  virtual bool IsMouseLocked(webkit::ppapi::PluginInstance* instance) OVERRIDE;
   virtual void DidChangeCursor(webkit::ppapi::PluginInstance* instance,
                                const WebKit::WebCursorInfo& cursor) OVERRIDE;
   virtual void DidReceiveMouseEvent(
       webkit::ppapi::PluginInstance* instance) OVERRIDE;
   virtual bool IsInFullscreenMode() OVERRIDE;
   virtual void SampleGamepads(WebKit::WebGamepads* data) OVERRIDE;
   virtual bool IsPageVisible() const OVERRIDE;
 
   // RenderViewObserver implementation.
   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
@@ skipping 28 matching lines @@
                               const std::string& data,
                               const PP_NetAddress_Private& addr);
 
   CONTENT_EXPORT int GetRoutingId() const;
 
  private:
   // Asynchronously attempts to create a PPAPI broker for the given plugin.
   scoped_refptr<PpapiBrokerImpl> CreatePpapiBroker(
       webkit::ppapi::PluginModule* plugin_module);
 
-  bool MouseLockedOrPending() const {
-    return mouse_locked_ || pending_lock_request_ || pending_unlock_request_;
-  }
-
   // Implementation of PepperParentContextProvider.
   virtual RendererGLContext* GetParentContextForPlatformContext3D() OVERRIDE;
 
   // Helper function to check that TCP/UDP private APIs are allowed for current
   // page. This check actually allows socket usage for NativeClient code only.
   // It is better to move this check to browser process but Pepper message
   // filters in browser process have no context about page that sent
   // the request. Doing this check in render process is safe because NaCl code
   // is executed in separate NaCl process.
   // TODO(dpolukhin, yzshen): make the check consistent for in- and out-process
   // cases and do the check during socket creation in the browser process.
   bool CanUseSocketAPIs();
 
+  MouseLockDispatcher::LockTarget* GetOrCreateLockTargetAdapter(
+      webkit::ppapi::PluginInstance* instance);
+  void UnSetAndDeleteLockTargetAdapter(webkit::ppapi::PluginInstance* instance);
+
   // Pointer to the RenderView that owns us.
   RenderViewImpl* render_view_;
 
   std::set<webkit::ppapi::PluginInstance*> active_instances_;
+  typedef std::map<webkit::ppapi::PluginInstance*,
+                   MouseLockDispatcher::LockTarget*> LockTargetMap;
+  LockTargetMap mouse_lock_instances_;
 
   // Used to send a single context menu "completion" upon menu close.
   bool has_saved_context_menu_action_;
   unsigned saved_context_menu_action_;
 
   IDMap<AsyncOpenFileCallback> pending_async_open_files_;
 
   IDMap<scoped_refptr<webkit::ppapi::PPB_Flash_NetConnector_Impl>,
         IDMapOwnPointer> pending_connect_tcps_;
 
   IDMap<webkit::ppapi::PPB_TCPSocket_Private_Impl> tcp_sockets_;
 
   IDMap<webkit::ppapi::PPB_UDPSocket_Private_Impl> udp_sockets_;
 
   IDMap<scoped_refptr<webkit::ppapi::PPB_Flash_Menu_Impl>,
         IDMapOwnPointer> pending_context_menus_;
 
   typedef IDMap<scoped_refptr<PpapiBrokerImpl>, IDMapOwnPointer> BrokerMap;
   BrokerMap pending_connect_broker_;
 
   // Whether or not the focus is on a PPAPI plugin
   webkit::ppapi::PluginInstance* focused_plugin_;
 
   // Current text input composition text. Empty if no composition is in
   // progress.
   string16 composition_text_;
 
-  // |mouse_lock_owner_| is not owned by this class. We can know about when it
-  // is destroyed via InstanceDeleted().
-  // |mouse_lock_owner_| being non-NULL doesn't indicate that currently the
-  // mouse has been locked. It is possible that a request to lock the mouse has
-  // been sent, but the response hasn't arrived yet.
-  webkit::ppapi::PluginInstance* mouse_lock_owner_;
-  bool mouse_locked_;
-  // If both |pending_lock_request_| and |pending_unlock_request_| are true,
-  // it means a lock request was sent before an unlock request and we haven't
-  // received responses for them.
-  // The logic in LockMouse() makes sure that a lock request won't be sent when
-  // there is a pending unlock request.
-  bool pending_lock_request_;
-  bool pending_unlock_request_;
-
   // The plugin instance that received the last mouse event. It is set to NULL
   // if the last mouse event went to elements other than Pepper plugins.
   // |last_mouse_event_target_| is not owned by this class. We can know about
   // when it is destroyed via InstanceDeleted().
   webkit::ppapi::PluginInstance* last_mouse_event_target_;
 
   scoped_ptr<content::GamepadSharedMemoryReader> gamepad_shared_memory_reader_;
 
   DISALLOW_COPY_AND_ASSIGN(PepperPluginDelegateImpl);
 };
 
 #endif  // CONTENT_RENDERER_PEPPER_PLUGIN_DELEGATE_IMPL_H_