refactoring mouse lock to support pepper and WebKit

content/renderer/render_view_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_RENDER_VIEW_IMPL_H_
 #define CONTENT_RENDERER_RENDER_VIEW_IMPL_H_
 #pragma once
 
 #include <deque>
 #include <map>
@@ skipping 289 matching lines @@
 
   // WebKit::WebWidgetClient implementation ------------------------------------
 
   // Most methods are handled by RenderWidget.
   virtual void didFocus();
   virtual void didBlur();
   virtual void show(WebKit::WebNavigationPolicy policy);
   virtual void runModal();
   virtual bool enterFullScreen();
   virtual void exitFullScreen();
+  virtual void lockPointer();
+  virtual void unlockPointer();
+  virtual bool isPointerLocked();
 
   // WebKit::WebViewClient implementation --------------------------------------
 
   virtual WebKit::WebView* createView(
       WebKit::WebFrame* creator,
       const WebKit::WebURLRequest& request,
       const WebKit::WebWindowFeatures& features,
       const WebKit::WebString& frame_name);
   virtual WebKit::WebWidget* createPopupMenu(WebKit::WebPopupType popup_type);
   virtual WebKit::WebWidget* createPopupMenu(
@@ skipping 470 matching lines @@
   void OnEnumerateDirectoryResponse(int id, const std::vector<FilePath>& paths);
   void OnExecuteEditCommand(const std::string& name, const std::string& value);
   void OnFileChooserResponse(const std::vector<FilePath>& paths);
   void OnFind(int request_id, const string16&, const WebKit::WebFindOptions&);
   void OnFindReplyAck();
   void OnGetAllSavableResourceLinksForCurrentPage(const GURL& page_url);
   void OnGetSerializedHtmlDataForCurrentPageWithLocalLinks(
       const std::vector<GURL>& links,
       const std::vector<FilePath>& local_paths,
       const FilePath& local_directory_name);
-  void OnLockMouseACK(bool succeeded);
   void OnMediaPlayerActionAt(const gfx::Point& location,
                              const WebKit::WebMediaPlayerAction& action);
+  void OnLockMouseACK(bool succeeded);
   void OnMouseLockLost();
   void OnMoveOrResizeStarted();
   CONTENT_EXPORT void OnNavigate(const ViewMsg_Navigate_Params& params);
   void OnPaste();
   void OnPasteAndMatchStyle();
 #if defined(OS_MACOSX)
   void OnPluginImeCompositionCompleted(const string16& text, int plugin_id);
 #endif
   void OnRedo();
   void OnReloadFrame();
@@ skipping 412 matching lines @@
 
   // ---------------------------------------------------------------------------
   // ADDING NEW DATA? Please see if it fits appropriately in one of the above
   // sections rather than throwing it randomly at the end. If you're adding a
   // bunch of stuff, you should probably create a helper class and put your
   // data and methods on that to avoid bloating RenderView more.  You can
   // use the Observer interface to filter IPC messages and receive frame change
   // notifications.
   // ---------------------------------------------------------------------------
 
+  // TEMP -- REFACTOR TO A DISPATCHER

[yzshen1, 2012/01/04 00:50:00]

We probably cannot check in the code without a nice dispatcher definition, even
if it is temporarily. :)

+public:
+  bool lockPointer(WebKit::WebWidget* webwidget) { return LockMouseInternal(webwidget, NULL); }
+  bool LockMouse(webkit::ppapi::PluginInstance* pinstance) { return LockMouseInternal(NULL, pinstance); }
+  void unlockPointer(WebKit::WebWidget* webwidget) { UnlockMouseInternal(webwidget, NULL); }
+  void UnlockMouse(webkit::ppapi::PluginInstance* pinstance) { UnlockMouseInternal(NULL, pinstance); }
+private:
+  bool LockMouseInternal(WebKit::WebWidget* webwidget, webkit::ppapi::PluginInstance* pinstance);
+  void UnlockMouseInternal(WebKit::WebWidget* webwidget, webkit::ppapi::PluginInstance* pinstance);
+  bool MouseLockedOrPendingAction() const {
+    return mouse_locked_ || pending_lock_request_ || pending_unlock_request_;
+  }
+
+  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_;
+
+  // |mouse_lock_owner_| is not owned by this class. 
+//???????? need to deal with it being deleted?

[yzshen1, 2012/01/04 00:50:00]

As far as PPAPI is concerned, we will get a notification when the instance gets
deleted. We will clean up the owner pointer if necessary.

You need to do similar things for WebKit::WebWidget.

+  // |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::WebWidget* mouse_lock_webwidget_owner_;
+  webkit::ppapi::PluginInstance* mouse_lock_pinstance_owner_;
+  // TEMP -- REFACTOR TO A DISPATCHER
+
   DISALLOW_COPY_AND_ASSIGN(RenderViewImpl);
 };
 
 #endif  // CONTENT_RENDERER_RENDER_VIEW_IMPL_H_