Mouse lock implementation, including the renderer side and the Windows version of the browser side.

content/renderer/pepper_plugin_delegate_impl.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 CONTENT_RENDERER_PEPPER_PLUGIN_DELEGATE_IMPL_H_
 #define CONTENT_RENDERER_PEPPER_PLUGIN_DELEGATE_IMPL_H_
 #pragma once
 
 #include <set>
 #include <map>
@@ skipping 26 matching lines @@
 struct WebPluginInfo;
 namespace ppapi {
 class PepperFilePath;
 class PluginInstance;
 class PluginModule;
 }
 }
 
 namespace WebKit {
 class WebFileChooserCompletion;
+class WebMouseEvent;
 struct WebFileChooserParams;
 }
 
 namespace webkit_glue {
 struct CustomContextMenuContext;
 }
 
 class TransportDIB;
 
 // This object is NOT thread-safe.
@@ skipping 101 matching lines @@
   // Removes broker from pending_connect_broker_ if present. Returns true if so.
   bool StopWaitingForPpapiBrokerConnection(PpapiBrokerImpl* broker);
 
   // Notification that the render view has been focused or defocused. This
   // notifies all of the plugins.
   void OnSetFocus(bool has_focus);
 
   // Returns whether or not a Pepper plugin is focused.
   bool IsPluginFocused() const;
 
+  // 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();
+  // Dispatches mouse events directly to the owner of the mouse lock.
+  // True indicates currently the mouse is locked and the event has been
+  // dispatched to the owner.
+  bool DispatchLockedMouseEvent(const WebKit::WebMouseEvent& event);
+
   // PluginDelegate implementation.
   virtual void PluginFocusChanged(bool focused) OVERRIDE;
   virtual void PluginCrashed(webkit::ppapi::PluginInstance* instance);
   virtual void InstanceCreated(
       webkit::ppapi::PluginInstance* instance);
   virtual void InstanceDeleted(
       webkit::ppapi::PluginInstance* instance);
   virtual SkBitmap* GetSadPluginBitmap();
   virtual PlatformAudio* CreateAudio(
       uint32_t sample_rate,
@@ skipping 117 matching lines @@
   virtual void DidStopLoading() OVERRIDE;
   virtual void SetContentRestriction(int restrictions) OVERRIDE;
   virtual void SaveURLAs(const GURL& url) OVERRIDE;
   virtual content::P2PSocketDispatcher* GetP2PSocketDispatcher() 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 void UnlockMouse(webkit::ppapi::PluginInstance* instance) OVERRIDE;
 
   int GetRoutingId() const;
 
  private:
   void PublishInitialPolicy(
       scoped_refptr<webkit::ppapi::PluginInstance> instance,
       const std::string& policy);
 
   // 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_;
+  }
+
   // Pointer to the RenderView that owns us.
   RenderView* render_view_;
 
   std::set<webkit::ppapi::PluginInstance*> active_instances_;
 
   // Used to send a single context menu "completion" upon menu close.
   bool has_saved_context_menu_action_;
   unsigned saved_context_menu_action_;
 
   // TODO(viettrungluu): Get rid of |id_generator_| -- just use |IDMap::Add()|.
@@ skipping 10 matching lines @@
   typedef IDMap<scoped_refptr<PpapiBrokerImpl>, IDMapOwnPointer> BrokerMap;
   BrokerMap pending_connect_broker_;
 
   // Whether or not the focus is on a PPAPI plugin
   bool is_pepper_plugin_focused_;
 
   // Set of instances to receive a notification when the enterprise policy has
   // been updated.
   std::set<webkit::ppapi::PluginInstance*> subscribed_to_policy_updates_;
 
+  // |mouse_lock_owner_| is not owned by this class. We can know about when it
+  // is destroyed via InstanceDeleted().
+  // |mouse_lock_owner_| is not NULL doesn't indicate that currently the mouse

[brettw, 2011/09/14 22:17:58]

is not NULL -> being non-NULL

[yzshen1, 2011/09/19 20:48:41]

Done.

+  // 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_;
+
   DISALLOW_COPY_AND_ASSIGN(PepperPluginDelegateImpl);
 };
 
 #endif  // CONTENT_RENDERER_PEPPER_PLUGIN_DELEGATE_IMPL_H_