refactoring mouse lock to support pepper and WebKit

webkit/plugins/ppapi/plugin_delegate.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 WEBKIT_PLUGINS_PPAPI_PLUGIN_DELEGATE_H_
 #define WEBKIT_PLUGINS_PPAPI_PLUGIN_DELEGATE_H_
 
 #include <string>
 
 #include "base/callback.h"
@@ skipping 472 matching lines @@
   // necessary.
   virtual std::string GetFlashCommandLineArgs() = 0;
 
   // Create an anonymous shared memory segment of size |size| bytes, and return
   // a pointer to it, or NULL on error.  Caller owns the returned pointer.
   virtual base::SharedMemory* CreateAnonymousSharedMemory(uint32_t size) = 0;
 
   // Returns the current preferences.
   virtual ::ppapi::Preferences GetPreferences() = 0;
 
-  // Locks the mouse for |instance|. It will call
-  // PluginInstance::OnLockMouseACK() to notify the instance when the operation
-  // is completed. The call to OnLockMouseACK() may be synchronous (i.e., it may
-  // be called when LockMouse() is still on the stack).
-  virtual void LockMouse(PluginInstance* instance) = 0;
+  // Locks the mouse for |instance|. If false is returned, the lock is not
+  // possible. If true is returned then the lock is pending. Success or
+  // failure will be delivered asynchronously via
+  // PluginInstance::OnLockMouseACK().
+  virtual bool LockMouse(PluginInstance* instance) = 0;
 
   // Unlocks the mouse if |instance| currently owns the mouse lock. Whenever an
   // plugin instance has lost the mouse lock, it will be notified by
   // PluginInstance::OnMouseLockLost(). Please note that UnlockMouse() is not
   // the only cause of losing mouse lock. For example, a user may press the Esc
   // key to quit the mouse lock mode, which also results in an OnMouseLockLost()
   // call to the current mouse lock owner.
   virtual void UnlockMouse(PluginInstance* instance) = 0;
 
+  // Returns true iff |instance| currently owns the mouse lock.
+  virtual bool IsMouseLocked(PluginInstance* instance) = 0;
+
   // Notifies that |instance| has changed the cursor.
   // This will update the cursor appearance if it is currently over the plugin
   // instance.
   virtual void DidChangeCursor(PluginInstance* instance,
                                const WebKit::WebCursorInfo& cursor) = 0;
 
   // Notifies that |instance| has received a mouse event.
   virtual void DidReceiveMouseEvent(PluginInstance* instance) = 0;
 
   // Determines if the browser entered fullscreen mode.
   virtual bool IsInFullscreenMode() = 0;
 
   // Retrieve current gamepad data.
   virtual void SampleGamepads(WebKit::WebGamepads* data) = 0;
 
   // Returns true if the containing page is visible.
   virtual bool IsPageVisible() const = 0;
 };
 
 }  // namespace ppapi
 }  // namespace webkit
 
 #endif  // WEBKIT_PLUGINS_PPAPI_PLUGIN_DELEGATE_H_