Make event-targeting asynchronous in window server.

services/ui/ws/window_manager_state.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 SERVICES_UI_WS_WINDOW_MANAGER_STATE_H_
 #define SERVICES_UI_WS_WINDOW_MANAGER_STATE_H_
 
 #include <stdint.h>
 
 #include <memory>
@@ skipping 82 matching lines @@
   // TODO(sky): EventDispatcher is really an implementation detail and should
   // not be exposed.
   EventDispatcher* event_dispatcher() { return &event_dispatcher_; }
 
   CursorState& cursor_state() { return cursor_state_; }
 
   // Returns true if this is the WindowManager of the active user.
   bool IsActive() const;
 
   void Activate(const gfx::Point& mouse_location_on_display,
-                const int64_t display_id);
+                int64_t display_id);
   void Deactivate();
 
   // Processes an event from PlatformDisplay.
   void ProcessEvent(const Event& event, int64_t display_id);
 
  private:
   class ProcessedEventTarget;
   friend class Display;
   friend class test::WindowManagerStateTestApi;
 
@@ skipping 36 matching lines @@
   struct QueuedEvent {
     QueuedEvent();
     ~QueuedEvent();
 
     std::unique_ptr<Event> event;
     std::unique_ptr<ProcessedEventTarget> processed_target;
     int64_t display_id;
   };
 
   // Tracks state associated with an event being dispatched to a client.
-  struct InFlightEventDetails {
-    InFlightEventDetails(WindowManagerState* window_manager_state,
-                         WindowTree* tree,
-                         int64_t display_id,
-                         const Event& event,
-                         EventDispatchPhase phase);
-    ~InFlightEventDetails();
+  struct InFlightEventDispatchDetails {
+    InFlightEventDispatchDetails(WindowManagerState* window_manager_state,
+                                 WindowTree* tree,
+                                 int64_t display_id,
+                                 const Event& event,
+                                 EventDispatchPhase phase);
+    ~InFlightEventDispatchDetails();
 
     base::OneShotTimer timer;
     WindowTree* tree;
     int64_t display_id;
     std::unique_ptr<Event> event;
     EventDispatchPhase phase;
     base::WeakPtr<Accelerator> post_target_accelerator;
     // Used for callbacks/timer specific to processing |event|.
     base::WeakPtrFactory<WindowManagerState> weak_factory;
   };
@@ skipping 33 matching lines @@
 
   // Implemenation of processing an event with a match phase of all. This
   // handles debug accelerators and forwards to EventDispatcher.
   void ProcessEventImpl(const Event& event, int64_t display_id);
 
   // Schedules an event to be processed later.
   void QueueEvent(const Event& event,
                   std::unique_ptr<ProcessedEventTarget> processed_event_target,
                   int64_t display_id);
 
-  // Processes the next valid event in |event_queue_|. If the event has already
-  // been processed it is dispatched, otherwise the event is passed to the
-  // EventDispatcher for processing.
-  void ProcessNextEventFromQueue();
-
   // Dispatches the event to the appropriate client and starts the ack timer.
   void DispatchInputEventToWindowImpl(ServerWindow* target,
                                       ClientSpecificId client_id,
-                                      const int64_t display_id,
+                                      int64_t display_id,
                                       const Event& event,
                                       base::WeakPtr<Accelerator> accelerator);
 
   // Registers accelerators used internally for debugging.
   void AddDebugAccelerators();
 
   // Finds the debug accelerator for |event| and if one is found calls
   // HandleDebugAccelerator().
-  void ProcessDebugAccelerator(const Event& event, const int64_t display_id);
+  void ProcessDebugAccelerator(const Event& event, int64_t display_id);
 
   // Runs the specified debug accelerator.
-  void HandleDebugAccelerator(DebugAcceleratorType type,
-                              const int64_t display_id);
+  void HandleDebugAccelerator(DebugAcceleratorType type, int64_t display_id);
 
   // Called when waiting for an event or accelerator to be processed by |tree|.
   void ScheduleInputEventTimeout(WindowTree* tree,
                                  ServerWindow* target,
-                                 const int64_t display_id,
+                                 int64_t display_id,
                                  const Event& event,
                                  EventDispatchPhase phase);
 
   // Helper function to convert |point| to be in screen coordinates. |point| as
   // the input should be in display-physical-pixel space, and the output is in
   // screen-dip space. Returns true if the |point| is successfully converted,
   // false otherwise.
-  bool ConvertPointToScreen(const int64_t display_id, gfx::Point* point);
+  bool ConvertPointToScreen(int64_t display_id, gfx::Point* point);
 
   // EventDispatcherDelegate:
   void OnAccelerator(uint32_t accelerator_id,
-                     const int64_t display_id,
+                     int64_t display_id,
                      const Event& event,
                      AcceleratorPhase phase) override;
   void SetFocusedWindowFromEventDispatcher(ServerWindow* window) override;
-  ServerWindow* GetFocusedWindowForEventDispatcher(
-      const int64_t display_id) override;
+  ServerWindow* GetFocusedWindowForEventDispatcher(int64_t display_id) override;
   void SetNativeCapture(ServerWindow* window) override;
   void ReleaseNativeCapture() override;
   void UpdateNativeCursorFromDispatcher() override;
   void OnCaptureChanged(ServerWindow* new_capture,
                         ServerWindow* old_capture) override;
   void OnMouseCursorLocationChanged(const gfx::Point& point,
-                                    const int64_t display_id) override;
+                                    int64_t display_id) override;
   void DispatchInputEventToWindow(ServerWindow* target,
                                   ClientSpecificId client_id,
-                                  const int64_t display_id,
+                                  int64_t display_id,
                                   const Event& event,
                                   Accelerator* accelerator) override;
+  // Processes the next valid event in |event_queue_|. If the event has already
+  // been processed it is dispatched, otherwise the event is passed to the
+  // EventDispatcher for processing.
+  void ProcessNextEventFromQueue() override;
   ClientSpecificId GetEventTargetClientId(const ServerWindow* window,
                                           bool in_nonclient_area) override;
   ServerWindow* GetRootWindowContaining(gfx::Point* location_in_display,
                                         int64_t* display_id) override;
-  void OnEventTargetNotFound(const Event& event,
-                             const int64_t display_id) override;
+  void OnEventTargetNotFound(const Event& event, int64_t display_id) override;
 
   // ServerWindowObserver:
   void OnWindowEmbeddedAppDisconnected(ServerWindow* window) override;
 
   // The single WindowTree this WindowManagerState is associated with.
   // |window_tree_| owns this.
   WindowTree* window_tree_;
 
   // Set to true the first time SetFrameDecorationValues() is called.
   bool got_frame_decoration_values_ = false;
   mojom::FrameDecorationValuesPtr frame_decoration_values_;
 
+  // Events can go into this queue if there's a hit-test in flight in
+  // EventDispatcher or if we are actively dispatching an event.
   std::queue<std::unique_ptr<QueuedEvent>> event_queue_;
 
   std::vector<DebugAccelerator> debug_accelerators_;
 
   // If non-null we're actively waiting for a response from a client for an
   // event.
-  std::unique_ptr<InFlightEventDetails> in_flight_event_details_;
+  std::unique_ptr<InFlightEventDispatchDetails>
+      in_flight_event_dispatch_details_;
 
   EventDispatcher event_dispatcher_;
 
   // PlatformDisplay that currently has capture.
   PlatformDisplay* platform_display_with_capture_ = nullptr;
 
   // All the active WindowManagerDisplayRoots.
   WindowManagerDisplayRoots window_manager_display_roots_;
 
   // Set of WindowManagerDisplayRoots corresponding to Displays that have been
   // destroyed. WindowManagerDisplayRoots are not destroyed immediately when
   // the Display is destroyed to allow the client to destroy the window when it
   // wants to. Once the client destroys the window WindowManagerDisplayRoots is
   // destroyed.
   WindowManagerDisplayRoots orphaned_window_manager_display_roots_;
 
   // All state regarding what the current cursor is.
   CursorState cursor_state_;
 
   DISALLOW_COPY_AND_ASSIGN(WindowManagerState);
 };
 
 }  // namespace ws
 }  // namespace ui
 
 #endif  // SERVICES_UI_WS_WINDOW_MANAGER_STATE_H_