Change mouse pointer event targets to the capturing node

third_party/WebKit/Source/core/input/PointerEventManager.h

 // Copyright 2016 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 PointerEventManager_h
 #define PointerEventManager_h
 
 #include "core/CoreExport.h"
 #include "core/events/PointerEvent.h"
 #include "core/events/PointerEventFactory.h"
@@ skipping 10 matching lines @@
 // This class takes care of dispatching all pointer events and keeps track of
 // properties of active pointer events.
 class CORE_EXPORT PointerEventManager {
     WTF_MAKE_NONCOPYABLE(PointerEventManager);
     DISALLOW_NEW();
 public:
     explicit PointerEventManager(LocalFrame*);
     ~PointerEventManager();
     DECLARE_TRACE();
 
+    // Sends the mouse pointer events and the boundary events
+    // that it may cause. It also sends the compat mouse events
+    // and sets the newNodeUnderMouse if the capturing is set
+    // in this function.
     WebInputEventResult sendMousePointerEvent(
-        Node*, const AtomicString& type,
+        Node* target, const AtomicString& type,
         int clickCount, const PlatformMouseEvent&,
         Node* relatedTarget,
-        Node* lastNodeUnderMouse);
+        Node* lastNodeUnderMouse,
+        Node** newNodeUnderMouse);
 
     WebInputEventResult handleTouchEvents(
         const PlatformTouchEvent&);
 
     // Sends boundary events mouseout/leave/over/enter to the
     // corresponding targets. This function sends pointerout/leave/over/enter
     // only when isFrameBoundaryTransition is true which indicates the
     // transition is over the document boundary and not only the elements border
     // inside the document. If isFrameBoundaryTransition is false,
     // then the event is a compatibility event like those created by touch
@@ skipping 12 matching lines @@
     void clear();
 
     void elementRemoved(EventTarget*);
     void setPointerCapture(int, EventTarget*);
     void releasePointerCapture(int, EventTarget*);
     bool isActive(const int) const;
 
     // Returns whether there is any touch on the screen.
     bool isAnyTouchActive() const;
 
+    // TODO(crbug.com/625843): This can be hidden when mouse refactoring in EventHandler is done.
+    EventTarget* getMouseCapturingNode();
+
     // Returns true if the primary pointerdown corresponding to the given
     // |uniqueTouchEventId| was canceled. Also drops stale ids from
     // |m_touchIdsForCanceledPointerdowns|.
     bool primaryPointerdownCanceled(uint32_t uniqueTouchEventId);
 
-    // Try to immediately send the got/lostpointercapture without boundary
-    // events.
+    // Processes the assignment of |m_pointerCaptureTarget| from |m_pendingPointerCaptureTarget|
+    // and sends the got/lostpointercapture events, as per the spec:
+    // https://w3c.github.io/pointerevents/#process-pending-pointer-capture
     // TODO(crbug.com/629935): This function should be private as soon as PointerEventManager
     // a GC managed object and postTask can be done internally in this class.
-    void immediatelyProcessPendingPointerCapture(int pointerId);
+    void processPendingPointerCapture(int pointerId);
 
 private:
     typedef HeapHashMap<int, Member<EventTarget>, WTF::IntHash<int>,
         WTF::UnsignedWithZeroKeyHashTraits<int>> PointerCapturingMap;
     class EventTargetAttributes {
         DISALLOW_NEW_EXCEPT_PLACEMENT_NEW();
     public:
         DEFINE_INLINE_TRACE()
         {
             visitor->trace(target);
@@ skipping 26 matching lines @@
     // Returns whether the event is consumed or not.
     WebInputEventResult sendTouchPointerEvent(EventTarget*, PointerEvent*);
 
     void sendBoundaryEvents(
         EventTarget* exitedTarget,
         EventTarget* enteredTarget,
         PointerEvent*,
         const PlatformMouseEvent& = PlatformMouseEvent(),
         bool sendMouseEvent = false);
     void setNodeUnderPointer(PointerEvent*,
-        EventTarget*, bool sendEvent = true);
-
-    // Processes the assignment of |m_pointerCaptureTarget| from |m_pendingPointerCaptureTarget|
-    // and sends the got/lostpointercapture events, as per the spec:
-    // https://w3c.github.io/pointerevents/#process-pending-pointer-capture
-    // Returns whether the pointer capture is changed. When pointer capture is changed,
-    // this function will take care of boundary events.
-    bool processPendingPointerCapture(
-        PointerEvent*,
-        EventTarget*,
-        const PlatformMouseEvent& = PlatformMouseEvent(),
-        bool sendMouseEvent = false);
+        EventTarget*);
 
     // Processes the capture state of a pointer, updates node under
     // pointer, and sends corresponding boundary events for pointer if
     // setPointerPosition is true. It also sends corresponding boundary events
     // for mouse if sendMouseEvent is true.
-    void processCaptureAndPositionOfPointerEvent(
+    // Returns the target that the pointer event is supposed to be fired at.
+    EventTarget* processCaptureAndPositionOfPointerEvent(
         PointerEvent*,
         EventTarget* hitTestTarget,
         EventTarget* lastNodeUnderMouse = nullptr,
         const PlatformMouseEvent& = PlatformMouseEvent(),
         bool sendMouseEvent = false,
         bool setPointerPosition = true);
 
     void removeTargetFromPointerCapturingMapping(
         PointerCapturingMap&, const EventTarget*);
     EventTarget* getEffectiveTargetForPointerEvent(
         EventTarget*, int);
     EventTarget* getCapturingNode(int);
     void removePointer(PointerEvent*);
     WebInputEventResult dispatchPointerEvent(
         EventTarget*,
         PointerEvent*,
         bool checkForListener = false);
-    void modifyPendingPointerCapture(int pointerId, EventTarget*);
+    // Set |m_pendingPointerCaptureTarget| for the given pointerId to the given
+    // target. It calls |processPendingPointerCapture| immediately if immediate
+    // is set. Otherwise it schedules it based on the heuristic to prevent
+    // the infinite look between lost/gotpointercapture handlers.
+    void modifyPendingPointerCapture(int pointerId, EventTarget*,
+        bool immediate = false);
     // Returns true if capture target and pending capture target were different.
     bool getPointerCaptureState(int pointerId,
         EventTarget** pointerCaptureTarget,
         EventTarget** pendingPointerCaptureTarget);
 
     // NOTE: If adding a new field to this class please ensure that it is
     // cleared in |PointerEventManager::clear()|.
 
     const Member<LocalFrame> m_frame;
 
@@ skipping 19 matching lines @@
     PointerCapturingMap m_pointerCaptureTarget;
     PointerCapturingMap m_pendingPointerCaptureTarget;
 
     PointerEventFactory m_pointerEventFactory;
     TouchEventManager m_touchEventManager;
 };
 
 } // namespace blink
 
 #endif // PointerEventManager_h