chromeos: converts observed pointer events to DIPs

services/ui/ws/window_manager_state.cc

 // 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.
 
 #include "services/ui/ws/window_manager_state.h"
 
 #include <utility>
 
 #include "base/memory/weak_ptr.h"
 #include "services/service_manager/public/interfaces/connector.mojom.h"
@@ skipping 49 matching lines @@
 const ServerWindow* GetEmbedRoot(const ServerWindow* window) {
   DCHECK(window);
   const ServerWindow* embed_root = window->parent();
   while (embed_root && embed_root->id().client_id == window->id().client_id)
     embed_root = embed_root->parent();
   return embed_root;
 }
 
 }  // namespace
 
+WindowManagerState::InFlightEventDetails::InFlightEventDetails(
+    WindowTree* tree,
+    int64_t display_id,
+    const Event& event,
+    EventDispatchPhase phase)
+    : tree(tree),
+      display_id(display_id),
+      event(Event::Clone(event)),
+      phase(phase) {}
+
+WindowManagerState::InFlightEventDetails::~InFlightEventDetails() {}
+
 class WindowManagerState::ProcessedEventTarget {
  public:
   ProcessedEventTarget(ServerWindow* window,
                        ClientSpecificId client_id,
                        Accelerator* accelerator)
       : client_id_(client_id) {
     tracker_.Add(window);
     if (accelerator)
       accelerator_ = accelerator->GetWeakPtr();
   }
@@ skipping 82 matching lines @@
   event_dispatcher_.ReleaseCaptureBlockedByAnyModalWindow();
 }
 
 void WindowManagerState::SetDragDropSourceWindow(
     DragSource* drag_source,
     ServerWindow* window,
     DragTargetConnection* source_connection,
     const std::unordered_map<std::string, std::vector<uint8_t>>& drag_data,
     uint32_t drag_operation) {
   int32_t drag_pointer = PointerEvent::kMousePointerId;
-  if (event_awaiting_input_ack_ &&
-      event_awaiting_input_ack_->IsPointerEvent()) {
-    drag_pointer = event_awaiting_input_ack_->AsPointerEvent()->pointer_id();
+  if (in_flight_event_details_ &&
+      in_flight_event_details_->event->IsPointerEvent()) {
+    drag_pointer =
+        in_flight_event_details_->event->AsPointerEvent()->pointer_id();
   } else {
     NOTIMPLEMENTED() << "Set drag drop set up during something other than a "
                      << "pointer event; rejecting drag.";
     drag_source->OnDragCompleted(false, ui::mojom::kDropEffectNone);
     return;
   }
 
   event_dispatcher_.SetDragDropSourceWindow(drag_source, window,
                                             source_connection, drag_pointer,
                                             drag_data, drag_operation);
@@ skipping 13 matching lines @@
   event_dispatcher_.AddSystemModalWindow(window);
 }
 
 const UserId& WindowManagerState::user_id() const {
   return window_tree_->user_id();
 }
 
 void WindowManagerState::OnWillDestroyTree(WindowTree* tree) {
   event_dispatcher_.OnWillDestroyDragTargetConnection(tree);
 
-  if (tree_awaiting_input_ack_ != tree)
+  if (!in_flight_event_details_ || in_flight_event_details_->tree != tree)
     return;
 
   // The WindowTree is dying. So it's not going to ack the event.
   // If the dying tree matches the root |tree_| marked as handled so we don't
   // notify it of accelerators.
-  OnEventAck(tree_awaiting_input_ack_, tree == window_tree_
-                                           ? mojom::EventResult::HANDLED
-                                           : mojom::EventResult::UNHANDLED);
+  OnEventAck(in_flight_event_details_->tree,
+             tree == window_tree_ ? mojom::EventResult::HANDLED
+                                  : mojom::EventResult::UNHANDLED);
 }
 
 ServerWindow* WindowManagerState::GetOrphanedRootWithId(const WindowId& id) {
   for (auto& display_root_ptr : orphaned_window_manager_display_roots_) {
     if (display_root_ptr->root()->id() == id)
       return display_root_ptr->root();
   }
   return nullptr;
 }
 
 bool WindowManagerState::IsActive() const {
   return window_server()->user_id_tracker()->active_id() == user_id();
 }
 
 void WindowManagerState::Activate(const gfx::Point& mouse_location_on_screen) {
   SetAllRootWindowsVisible(true);
   event_dispatcher_.Reset();
   event_dispatcher_.SetMousePointerScreenLocation(mouse_location_on_screen);
 }
 
 void WindowManagerState::Deactivate() {
   SetAllRootWindowsVisible(false);
   event_dispatcher_.Reset();
   // The tree is no longer active, so no point in dispatching any further
   // events.
   std::queue<std::unique_ptr<QueuedEvent>> event_queue;
   event_queue.swap(event_queue_);
 }
 
-void WindowManagerState::ProcessEvent(const ui::Event& event) {
+void WindowManagerState::ProcessEvent(const ui::Event& event,
+                                      int64_t display_id) {
   // If this is still waiting for an ack from a previously sent event, then
   // queue up the event to be dispatched once the ack is received.
-  if (event_ack_timer_.IsRunning()) {
+  if (in_flight_event_details_) {
     if (!event_queue_.empty() && !event_queue_.back()->processed_target &&
         EventsCanBeCoalesced(*event_queue_.back()->event, event)) {
       event_queue_.back()->event = CoalesceEvents(
           std::move(event_queue_.back()->event), ui::Event::Clone(event));
+      event_queue_.back()->display_id = display_id;
       return;
     }
-    QueueEvent(event, nullptr);
+    QueueEvent(event, nullptr, display_id);
     return;
   }
 
-  ProcessEventImpl(event);
+  ProcessEventImpl(event, display_id);
 }
 
 void WindowManagerState::OnEventAck(mojom::WindowTree* tree,
                                     mojom::EventResult result) {
-  if (tree_awaiting_input_ack_ != tree ||
-      event_dispatch_phase_ != EventDispatchPhase::TARGET) {
+  if (!in_flight_event_details_ || in_flight_event_details_->tree != tree ||
+      in_flight_event_details_->phase != EventDispatchPhase::TARGET) {
     // TODO(sad): The ack must have arrived after the timeout. We should do
     // something here, and in OnEventAckTimeout().
     return;
   }
-  tree_awaiting_input_ack_ = nullptr;
-  event_ack_timer_.Stop();
+  std::unique_ptr<InFlightEventDetails> details =
+      std::move(in_flight_event_details_);
 
   base::WeakPtr<Accelerator> post_target_accelerator = post_target_accelerator_;
   post_target_accelerator_.reset();
-  std::unique_ptr<ui::Event> event = std::move(event_awaiting_input_ack_);
 
   if (result == mojom::EventResult::UNHANDLED && post_target_accelerator) {
-    OnAccelerator(post_target_accelerator->id(), *event,
+    OnAccelerator(post_target_accelerator->id(), *details->event,
                   AcceleratorPhase::POST);
   }
 
-  event_dispatch_phase_ = EventDispatchPhase::NONE;
   ProcessNextEventFromQueue();
 }
 
 void WindowManagerState::OnAcceleratorAck(mojom::EventResult result) {
-  if (event_dispatch_phase_ != EventDispatchPhase::PRE_TARGET_ACCELERATOR) {
+  if (!in_flight_event_details_ ||
+      in_flight_event_details_->phase !=
+          EventDispatchPhase::PRE_TARGET_ACCELERATOR) {
     // TODO(sad): The ack must have arrived after the timeout. We should do
     // something here, and in OnEventAckTimeout().
     return;
   }
 
-  tree_awaiting_input_ack_ = nullptr;
-  event_ack_timer_.Stop();
-  event_dispatch_phase_ = EventDispatchPhase::NONE;
-  std::unique_ptr<ui::Event> event = std::move(event_awaiting_input_ack_);
+  std::unique_ptr<InFlightEventDetails> details =
+      std::move(in_flight_event_details_);
 
   if (result == mojom::EventResult::UNHANDLED) {
+    event_processing_display_id_ = details->display_id;
     event_dispatcher_.ProcessEvent(
-        *event, EventDispatcher::AcceleratorMatchPhase::POST_ONLY);
+        *details->event, EventDispatcher::AcceleratorMatchPhase::POST_ONLY);
   } else {
     // We're not going to process the event any further, notify event observers.
     // We don't do this first to ensure we don't send an event twice to clients.
-    window_server()->SendToPointerWatchers(*event, user_id(), nullptr, nullptr);
+    window_server()->SendToPointerWatchers(*details->event, user_id(), nullptr,
+                                           nullptr, details->display_id);
     ProcessNextEventFromQueue();
   }
 }
 
 const WindowServer* WindowManagerState::window_server() const {
   return window_tree_->window_server();
 }
 
 WindowServer* WindowManagerState::window_server() {
   return window_tree_->window_server();
@@ skipping 40 matching lines @@
       return display_root_ptr->root();
   }
   NOTREACHED();
   return nullptr;
 }
 
 void WindowManagerState::OnEventAckTimeout(ClientSpecificId client_id) {
   WindowTree* hung_tree = window_server()->GetTreeWithId(client_id);
   if (hung_tree && !hung_tree->janky())
     window_tree_->ClientJankinessChanged(hung_tree);
-  if (event_dispatch_phase_ == EventDispatchPhase::PRE_TARGET_ACCELERATOR)
+  if (in_flight_event_details_->phase ==
+      EventDispatchPhase::PRE_TARGET_ACCELERATOR) {
     OnAcceleratorAck(mojom::EventResult::UNHANDLED);
-  else
-    OnEventAck(tree_awaiting_input_ack_, mojom::EventResult::UNHANDLED);
+  } else {
+    OnEventAck(
+        in_flight_event_details_ ? in_flight_event_details_->tree : nullptr,
+        mojom::EventResult::UNHANDLED);
+  }
 }
 
-void WindowManagerState::ProcessEventImpl(const ui::Event& event) {
+void WindowManagerState::ProcessEventImpl(const ui::Event& event,
+                                          int64_t display_id) {
   // Debug accelerators are always checked and don't interfere with processing.
   ProcessDebugAccelerator(event);
+  event_processing_display_id_ = display_id;
   event_dispatcher_.ProcessEvent(event,
                                  EventDispatcher::AcceleratorMatchPhase::ANY);

[sadrul, 2017/02/09 02:27:45]

Should we carry |display_id| through into EventDispatcher?

[sky, 2017/02/09 17:06:20]

I was tempted to, but then EventDispatcher doesn't need it for anything and
EventDispatcher is entirely driven by WindowManagerState, so I didn't see a
reason to.

 }
 
 void WindowManagerState::QueueEvent(
     const ui::Event& event,
-    std::unique_ptr<ProcessedEventTarget> processed_event_target) {
+    std::unique_ptr<ProcessedEventTarget> processed_event_target,
+    int64_t display_id) {
   std::unique_ptr<QueuedEvent> queued_event(new QueuedEvent);
   queued_event->event = ui::Event::Clone(event);
   queued_event->processed_target = std::move(processed_event_target);
+  queued_event->display_id = display_id;
   event_queue_.push(std::move(queued_event));
 }
 
 void WindowManagerState::ProcessNextEventFromQueue() {
   // Loop through |event_queue_| stopping after dispatching the first valid
   // event.
   while (!event_queue_.empty()) {
     std::unique_ptr<QueuedEvent> queued_event = std::move(event_queue_.front());
     event_queue_.pop();
     if (!queued_event->processed_target) {
-      ProcessEventImpl(*queued_event->event);
+      ProcessEventImpl(*queued_event->event, queued_event->display_id);
       return;
     }
     if (queued_event->processed_target->IsValid()) {
       DispatchInputEventToWindowImpl(
           queued_event->processed_target->window(),
           queued_event->processed_target->client_id(), *queued_event->event,
           queued_event->processed_target->accelerator());
       return;
     }
   }
 }
 
 void WindowManagerState::DispatchInputEventToWindowImpl(
     ServerWindow* target,
     ClientSpecificId client_id,
     const ui::Event& event,
     base::WeakPtr<Accelerator> accelerator) {
-  if (target && target->parent() == nullptr)
+  DCHECK(target);
+  if (target->parent() == nullptr)
     target = GetWindowManagerRoot(target);
 
   if (event.IsMousePointerEvent()) {
     DCHECK(event_dispatcher_.mouse_cursor_source_window());
     UpdateNativeCursorFromDispatcher();
   }
 
-  event_dispatch_phase_ = EventDispatchPhase::TARGET;
-
   WindowTree* tree = window_server()->GetTreeWithId(client_id);
   DCHECK(tree);
-  ScheduleInputEventTimeout(tree);
-
-  event_awaiting_input_ack_ = ui::Event::Clone(event);
+  ScheduleInputEventTimeout(tree, target, event, EventDispatchPhase::TARGET);
 
   if (accelerator)
     post_target_accelerator_ = accelerator;
 
   // Ignore |tree| because it will receive the event via normal dispatch.
-  window_server()->SendToPointerWatchers(event, user_id(), target, tree);
+  window_server()->SendToPointerWatchers(event, user_id(), target, tree,
+                                         in_flight_event_details_->display_id);
 
   tree->DispatchInputEvent(target, event);
 }
 
 void WindowManagerState::AddDebugAccelerators() {
   const DebugAccelerator accelerator = {
       DebugAcceleratorType::PRINT_WINDOWS, ui::VKEY_S,
       ui::EF_CONTROL_DOWN | ui::EF_ALT_DOWN | ui::EF_SHIFT_DOWN};
   debug_accelerators_.push_back(accelerator);
 }
@@ skipping 18 matching lines @@
     WindowManagerDisplayRoot* display_root =
         display->GetWindowManagerDisplayRootForUser(user_id());
     if (display_root) {
       LOG(ERROR) << "ServerWindow hierarchy:\n"
                  << display_root->root()->GetDebugWindowHierarchy();
     }
   }
 #endif
 }
 
-void WindowManagerState::ScheduleInputEventTimeout(WindowTree* tree) {
+void WindowManagerState::ScheduleInputEventTimeout(WindowTree* tree,
+                                                   ServerWindow* target,
+                                                   const Event& event,
+                                                   EventDispatchPhase phase) {
+  std::unique_ptr<InFlightEventDetails> details =
+      base::MakeUnique<InFlightEventDetails>(tree, event_processing_display_id_,
+                                             event, phase);
+
   // TOOD(sad): Adjust this delay, possibly make this dynamic.
   const base::TimeDelta max_delay = base::debug::BeingDebugged()
                                         ? base::TimeDelta::FromDays(1)
                                         : GetDefaultAckTimerDelay();
-  event_ack_timer_.Start(FROM_HERE, max_delay,
-                         base::Bind(&WindowManagerState::OnEventAckTimeout,
-                                    weak_factory_.GetWeakPtr(), tree->id()));
-
-  tree_awaiting_input_ack_ = tree;
+  details->timer.Start(FROM_HERE, max_delay,
+                       base::Bind(&WindowManagerState::OnEventAckTimeout,
+                                  weak_factory_.GetWeakPtr(), tree->id()));
+  in_flight_event_details_ = std::move(details);
 }
 
 ////////////////////////////////////////////////////////////////////////////////
 // EventDispatcherDelegate:
 
 void WindowManagerState::OnAccelerator(uint32_t accelerator_id,
                                        const ui::Event& event,
                                        AcceleratorPhase phase) {
   DCHECK(IsActive());
   const bool needs_ack = phase == AcceleratorPhase::PRE;
   if (needs_ack) {
-    DCHECK_EQ(EventDispatchPhase::NONE, event_dispatch_phase_);
-    event_dispatch_phase_ = EventDispatchPhase::PRE_TARGET_ACCELERATOR;
-    event_awaiting_input_ack_ = ui::Event::Clone(event);
-    ScheduleInputEventTimeout(window_tree_);
+    DCHECK(!in_flight_event_details_);
+    ScheduleInputEventTimeout(window_tree_, nullptr, event,
+                              EventDispatchPhase::PRE_TARGET_ACCELERATOR);
   }
   window_tree_->OnAccelerator(accelerator_id, event, needs_ack);
 }
 
 void WindowManagerState::SetFocusedWindowFromEventDispatcher(
     ServerWindow* new_focused_window) {
   DCHECK(IsActive());
   window_server()->SetFocusedWindow(new_focused_window);
 }
 
@@ skipping 39 matching lines @@
       ->OnMouseCursorLocationChanged(point);
 }
 
 void WindowManagerState::DispatchInputEventToWindow(ServerWindow* target,
                                                     ClientSpecificId client_id,
                                                     const ui::Event& event,
                                                     Accelerator* accelerator) {
   DCHECK(IsActive());
   // TODO(sky): this needs to see if another wms has capture and if so forward
   // to it.
-  if (event_ack_timer_.IsRunning()) {
+  if (in_flight_event_details_) {
     std::unique_ptr<ProcessedEventTarget> processed_event_target(
         new ProcessedEventTarget(target, client_id, accelerator));
-    QueueEvent(event, std::move(processed_event_target));
+    QueueEvent(event, std::move(processed_event_target),
+               event_processing_display_id_);

[sadrul, 2017/02/09 02:27:45]

Is |event_processing_display_id_| always going to be the correct display-id? For
example, if EventDispatcher is generating a pointer-exit event, that could be
going to a window that lives in a different display. Should we get the
display-id from |target| instead?

[sky, 2017/02/09 17:06:20]

With this patch all non-pointer-watcher events get the display id of the display
the window is on (see line 1153 in services/ui/ws/window_tree.cc). That leaves
pointer-watcher events. With this patch pointer-watcher events get the display
id of the display the event is generated on. This seems right given the client
uses that display to convert pixels to dips. That said, I don't know the state
of how we position multiple displays with differing densities. I believe
currently the positioning is done at the DIP level and I don't know if care is
taken to make sure the pixel boundaries line up nicely.

     return;
   }
 
   base::WeakPtr<Accelerator> weak_accelerator;
   if (accelerator)
     weak_accelerator = accelerator->GetWeakPtr();
   DispatchInputEventToWindowImpl(target, client_id, event, weak_accelerator);
 }
 
 ClientSpecificId WindowManagerState::GetEventTargetClientId(
@@ skipping 48 matching lines @@
   // Translate the location to be relative to the display instead of relative
   // to the screen space.
   gfx::Point origin =
       target_display_root->display()->platform_display()->GetBounds().origin();
   *location -= origin.OffsetFromOrigin();
   return target_display_root->root();
 }
 
 void WindowManagerState::OnEventTargetNotFound(const ui::Event& event) {
   window_server()->SendToPointerWatchers(event, user_id(), nullptr, /* window */
-                                         nullptr /* ignore_tree */);
+                                         nullptr /* ignore_tree */,
+                                         event_processing_display_id_);

[sadrul, 2017/02/09 02:27:45]

Is this going to be correct? I assume an |event| that didn't find a target will
be in the coord-space of the screen. In that case, specifying a display-id would
probably be confusing? Perhaps just send -1 as the invalid/unknown display-id?

[sky, 2017/02/09 17:06:20]

See comment above. I believe this is right.

   if (event.IsMousePointerEvent())
     UpdateNativeCursorFromDispatcher();
 }
 
 void WindowManagerState::OnWindowEmbeddedAppDisconnected(ServerWindow* window) {
   for (auto iter = orphaned_window_manager_display_roots_.begin();
        iter != orphaned_window_manager_display_roots_.end(); ++iter) {
     if ((*iter)->root() == window) {
       window->RemoveObserver(this);
       orphaned_window_manager_display_roots_.erase(iter);
       return;
     }
   }
   NOTREACHED();
 }
 
 }  // namespace ws
 }  // namespace ui