Unify the code paths for handling mouse events when pointer is locked on

third_party/WebKit/Source/web/WebViewImpl.cpp

 /*
  * Copyright (C) 2011, 2012 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 2152 matching lines @@
                                                      &inputEvent);
   UIEventWithKeyState::clearNewTabModifierSetFromIsolatedWorld();
 
   bool isPointerLocked = false;
   if (WebFrameWidgetBase* widget = mainFrameImpl()->frameWidget()) {
     if (WebWidgetClient* client = widget->client())
       isPointerLocked = client->isPointerLocked();
   }
 
   if (isPointerLocked && WebInputEvent::isMouseEventType(inputEvent.type())) {
-    pointerLockMouseEvent(inputEvent);
+    mainFrameImpl()->frameWidget()->pointerLockMouseEvent(inputEvent);
     return WebInputEventResult::HandledSystem;
   }
 
   if (m_mouseCaptureNode &&
       WebInputEvent::isMouseEventType(inputEvent.type())) {
     TRACE_EVENT1("input", "captured mouse event", "type", inputEvent.type());
     // Save m_mouseCaptureNode since mouseCaptureLost() will clear it.
     Node* node = m_mouseCaptureNode;
 
     // Not all platforms call mouseCaptureLost() directly.
@@ skipping 332 matching lines @@
     page()->willCloseLayerTreeView(*m_layerTreeView, nullptr);
 
   setRootLayer(nullptr);
   m_animationHost = nullptr;
 
   m_mutator = nullptr;
   m_layerTreeView = nullptr;
 }
 
 void WebViewImpl::didAcquirePointerLock() {
-  if (page())
-    page()->pointerLockController().didAcquirePointerLock();
+  mainFrameImpl()->frameWidget()->didAcquirePointerLock();
 }
 
 void WebViewImpl::didNotAcquirePointerLock() {
-  if (page())
-    page()->pointerLockController().didNotAcquirePointerLock();
+  mainFrameImpl()->frameWidget()->didNotAcquirePointerLock();
 }
 
 void WebViewImpl::didLosePointerLock() {
-  m_pointerLockGestureToken.clear();
-  if (page())
-    page()->pointerLockController().didLosePointerLock();
+  mainFrameImpl()->frameWidget()->didLosePointerLock();

[dcheng, 2017/02/13 23:21:28]

Can we remove these from being exposed via WebView altogether?

[lfg, 2017/02/14 15:42:49]

Not until more work is done; in particular, the RenderWidget calls these
functions, and the WebWidget that's associated with the RenderWidget is still a
WebViewImpl, instead of a WebFrameWidget.

[dcheng, 2017/02/14 19:20:28]

Is this something the content side patches that you mentioned earlier today
would do?

[lfg, 2017/02/14 19:29:03]

No, unfortunately not. This is due to the design of
content::MouseLockDispatcher, which gets created in RenderWidget::Init, before
the WebViewFrameWidget is created, so it can only be associated with the
WebViewImpl at that point. To remove those from being exposed in WebView, we
would either have to redesign the lifetime of the mouse lock objects, or
associate the RenderWidget with the WebViewFrameWidget (I tried to do that in
the past, and there was a lot of other lifetime issues related closing the
WebViewFrameWidget and the WebViewImpl).

See https://cs.chromium.org/chromium/src/content/renderer/render_widget.cc?l=539

[dcheng, 2017/02/14 23:46:10]

I assume we have a long-term bug for cleaning this up. If not, do you mind
filing one?

 }
 
 // TODO(ekaramad):This method is almost duplicated in WebFrameWidgetImpl as
 // well. This code needs to be refactored  (http://crbug.com/629721).
 bool WebViewImpl::getCompositionCharacterBounds(WebVector<WebRect>& bounds) {
   WebRange range = compositionRange();
   if (range.isEmpty())
     return false;
 
   WebLocalFrame* frame = focusedFrame();
@@ skipping 1529 matching lines @@
 
 void WebViewImpl::setCompositorVisibility(bool isVisible) {
   if (!isVisible)
     m_overrideCompositorVisibility = true;
   else
     m_overrideCompositorVisibility = false;
   if (m_layerTreeView)
     m_layerTreeView->setVisible(isVisible);
 }
 
-void WebViewImpl::pointerLockMouseEvent(const WebInputEvent& event) {
-  std::unique_ptr<UserGestureIndicator> gestureIndicator;
-  AtomicString eventType;
-  switch (event.type()) {
-    case WebInputEvent::MouseDown:
-      eventType = EventTypeNames::mousedown;
-      if (!page() || !page()->pointerLockController().element())
-        break;
-      gestureIndicator = WTF::wrapUnique(
-          new UserGestureIndicator(DocumentUserGestureToken::create(
-              &page()->pointerLockController().element()->document(),
-              UserGestureToken::NewGesture)));
-      m_pointerLockGestureToken = gestureIndicator->currentToken();
-      break;
-    case WebInputEvent::MouseUp:
-      eventType = EventTypeNames::mouseup;
-      gestureIndicator = WTF::wrapUnique(
-          new UserGestureIndicator(m_pointerLockGestureToken.release()));
-      break;
-    case WebInputEvent::MouseMove:
-      eventType = EventTypeNames::mousemove;
-      break;
-    default:
-      NOTREACHED();
-  }
-
-  const WebMouseEvent& mouseEvent = static_cast<const WebMouseEvent&>(event);
-
-  if (page()) {
-    WebMouseEvent transformedEvent =
-        TransformWebMouseEvent(mainFrameImpl()->frameView(), mouseEvent);
-    page()->pointerLockController().dispatchLockedMouseEvent(transformedEvent,
-                                                             eventType);
-  }
-}
-
 void WebViewImpl::forceNextWebGLContextCreationToFail() {
   WebGLRenderingContext::forceNextWebGLContextCreationToFail();
 }
 
 void WebViewImpl::forceNextDrawingBufferCreationToFail() {
   DrawingBuffer::forceNextDrawingBufferCreationToFail();
 }
 
 CompositorMutatorImpl& WebViewImpl::mutator() {
   if (!m_mutator) {
@@ skipping 42 matching lines @@
   if (focusedFrame->localFrameRoot() != mainFrameImpl()->frame())
     return nullptr;
   return focusedFrame;
 }
 
 LocalFrame* WebViewImpl::focusedLocalFrameAvailableForIme() const {
   return m_imeAcceptEvents ? focusedLocalFrameInWidget() : nullptr;
 }
 
 }  // namespace blink