Move persistent gesture state to Document, add DocumentUserGestureToken

third_party/WebKit/Source/core/input/EventHandler.cpp

 /*
  * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights
  * reserved.
  * Copyright (C) 2006 Alexey Proskuryakov (ap@webkit.org)
  * Copyright (C) 2012 Digia Plc. and/or its subsidiary(-ies)
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
@@ skipping 16 matching lines @@
  */
 
 #include "core/input/EventHandler.h"
 
 #include "bindings/core/v8/ExceptionStatePlaceholder.h"
 #include "core/HTMLNames.h"
 #include "core/InputTypeNames.h"
 #include "core/clipboard/DataTransfer.h"
 #include "core/dom/DOMNodeIds.h"
 #include "core/dom/Document.h"
+#include "core/dom/DocumentUserGestureToken.h"
 #include "core/dom/TouchList.h"
 #include "core/dom/shadow/FlatTreeTraversal.h"
 #include "core/dom/shadow/ShadowRoot.h"
 #include "core/editing/EditingUtilities.h"
 #include "core/editing/Editor.h"
 #include "core/editing/FrameSelection.h"
 #include "core/editing/SelectionController.h"
 #include "core/events/EventPath.h"
 #include "core/events/GestureEvent.h"
 #include "core/events/KeyboardEvent.h"
@@ skipping 518 matching lines @@
     const PlatformMouseEvent& mouseEvent) {
   TRACE_EVENT0("blink", "EventHandler::handleMousePressEvent");
 
   // For 4th/5th button in the mouse since Chrome does not yet send
   // button value to Blink but in some cases it does send the event.
   // This check is needed to suppress such an event (crbug.com/574959)
   if (mouseEvent.pointerProperties().button ==
       WebPointerProperties::Button::NoButton)
     return WebInputEventResult::HandledSuppressed;
 
-  UserGestureIndicator gestureIndicator(UserGestureToken::create());
-  m_frame->localFrameRoot()->eventHandler().m_lastMouseDownUserGestureToken =
-      UserGestureIndicator::currentToken();
-
   if (m_eventHandlerWillResetCapturingMouseEventsNode)
     m_capturingMouseEventsNode = nullptr;
   m_mouseEventManager->handleMousePressEventUpdateStates(mouseEvent);
   selectionController().setMouseDownMayStartSelect(false);
   if (!m_frame->view())
     return WebInputEventResult::NotHandled;
 
   HitTestRequest request(HitTestRequest::Active);
   // Save the document point we generate in case the window coordinate is
   // invalidated by what happens when we dispatch the event.
@@ skipping 23 matching lines @@
         subframe->eventHandler().m_mouseEventManager->capturesDragging());
     if (m_mouseEventManager->mousePressed() &&
         m_mouseEventManager->capturesDragging()) {
       m_capturingMouseEventsNode = mev.innerNode();
       m_eventHandlerWillResetCapturingMouseEventsNode = true;
     }
     m_mouseEventManager->invalidateClick();
     return result;
   }
 
+  UserGestureIndicator gestureIndicator(
+      DocumentUserGestureToken::create(m_frame->document()));
+  m_frame->localFrameRoot()->eventHandler().m_lastMouseDownUserGestureToken =
+      UserGestureIndicator::currentToken();
+
   if (RuntimeEnabledFeatures::middleClickAutoscrollEnabled()) {
     // We store whether middle click autoscroll is in progress before calling
     // stopAutoscroll() because it will set m_autoscrollType to NoAutoscroll on
     // return.
     bool isMiddleClickAutoscrollInProgress =
         m_scrollManager->middleClickAutoscrollInProgress();
     m_scrollManager->stopAutoscroll();
     if (isMiddleClickAutoscrollInProgress) {
       // We invalidate the click when exiting middle click auto scroll so that
       // we don't inadvertently navigate away from the current page (e.g. the
@@ skipping 258 matching lines @@
   // For 4th/5th button in the mouse since Chrome does not yet send
   // button value to Blink but in some cases it does send the event.
   // This check is needed to suppress such an event (crbug.com/574959)
   if (mouseEvent.pointerProperties().button ==
       WebPointerProperties::Button::NoButton)
     return WebInputEventResult::HandledSuppressed;
 
   if (!mouseEvent.fromTouch())
     m_frame->selection().setCaretBlinkingSuspended(false);
 
-  std::unique_ptr<UserGestureIndicator> gestureIndicator;
-
-  if (m_frame->localFrameRoot()
-          ->eventHandler()
-          .m_lastMouseDownUserGestureToken) {
-    gestureIndicator = wrapUnique(new UserGestureIndicator(
-        m_frame->localFrameRoot()
-            ->eventHandler()
-            .m_lastMouseDownUserGestureToken.release()));
-  } else {
-    gestureIndicator =
-        wrapUnique(new UserGestureIndicator(UserGestureToken::create()));
-  }
-
   if (RuntimeEnabledFeatures::middleClickAutoscrollEnabled()) {
     if (Page* page = m_frame->page())
       page->autoscrollController().handleMouseReleaseForMiddleClickAutoscroll(
           m_frame, mouseEvent);
   }
 
   m_mouseEventManager->setMousePressed(false);
   m_mouseEventManager->setLastKnownMousePosition(mouseEvent);
   m_mouseEventManager->handleSvgPanIfNeeded(true);
 
@@ skipping 20 matching lines @@
       EventHandlingUtil::performMouseEventHitTest(m_frame, request, mouseEvent);
   LocalFrame* subframe =
       m_capturingMouseEventsNode.get()
           ? subframeForTargetNode(m_capturingMouseEventsNode.get())
           : subframeForHitTestResult(mev);
   if (m_eventHandlerWillResetCapturingMouseEventsNode)
     m_capturingMouseEventsNode = nullptr;
   if (subframe)
     return passMouseReleaseEventToSubframe(mev, subframe);
 
+  std::unique_ptr<UserGestureIndicator> gestureIndicator;

[Rick Byers, 2016/10/17 17:02:46]

So the effect of the mouse changes is that it's the document where the mousedown
occurred that gets associated with the user gesture.  If you mousedown in one
document, drag to another and mouseup there, the mouseup still has a gesture but
that document doesn't get "hasReceivedUserGesture".  Right?

I can't think of any reason why that's likely to be a problem, but it's probably
worth calling out in a comment since it's something that could cause confusion,
or something we want to think more deeply about in the future (eg. as part of
standardizing this behavior).

[Nate Chapin, 2016/10/18 23:26:33]

Done, and explicitly noted that this behavior may be wrong :)

+  if (m_frame->localFrameRoot()
+          ->eventHandler()
+          .m_lastMouseDownUserGestureToken) {
+    gestureIndicator = wrapUnique(new UserGestureIndicator(
+        m_frame->localFrameRoot()
+            ->eventHandler()
+            .m_lastMouseDownUserGestureToken.release()));
+  } else {
+    gestureIndicator = wrapUnique(new UserGestureIndicator(
+        DocumentUserGestureToken::create(m_frame->document())));
+  }
+
   WebInputEventResult eventResult = updatePointerTargetAndDispatchEvents(
       EventTypeNames::mouseup, mev.innerNode(), mev.event());
 
   WebInputEventResult clickEventResult =
       m_mouseEventManager->dispatchMouseClickIfNeeded(mev);
 
   m_scrollManager->clearResizeScrollableArea(false);
 
   if (eventResult == WebInputEventResult::NotHandled)
     eventResult = m_mouseEventManager->handleMouseReleaseEvent(mev);
@@ skipping 1086 matching lines @@
 }
 
 FrameHost* EventHandler::frameHost() const {
   if (!m_frame->page())
     return nullptr;
 
   return &m_frame->page()->frameHost();
 }
 
 }  // namespace blink