Fix bug in keeping capture in sync during destruction

ui/aura/mus/window_tree_client.h

 // Copyright 2014 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 UI_AURA_MUS_WINDOW_TREE_CLIENT_H_
 #define UI_AURA_MUS_WINDOW_TREE_CLIENT_H_
 
 #include <stdint.h>
 
 #include <map>
 #include <memory>
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/atomicops.h"
 #include "base/compiler_specific.h"
 #include "base/macros.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
 #include "mojo/public/cpp/bindings/associated_binding.h"
 #include "mojo/public/cpp/bindings/strong_binding.h"
 #include "services/ui/public/interfaces/window_tree.mojom.h"
 #include "ui/aura/aura_export.h"
-#include "ui/aura/client/capture_client_observer.h"
 #include "ui/aura/client/focus_change_observer.h"
 #include "ui/aura/client/transient_window_client_observer.h"
+#include "ui/aura/mus/capture_synchronizer_delegate.h"
 #include "ui/aura/mus/drag_drop_controller_host.h"
 #include "ui/aura/mus/mus_types.h"
 #include "ui/aura/mus/window_manager_delegate.h"
 #include "ui/aura/mus/window_tree_host_mus_delegate.h"
 
 namespace display {
 class Display;
 }
 
 namespace gfx {
 class Insets;
 }
 
 namespace service_manager {
 class Connector;
 }
 
 namespace aura {
+class CaptureSynchronizer;
 class DragDropControllerMus;
 class InFlightBoundsChange;
-class InFlightCaptureChange;
 class InFlightChange;
 class InFlightFocusChange;
 class InFlightPropertyChange;
 class InFlightVisibleChange;
 class WindowMus;
 class WindowPortMus;
 struct WindowPortInitData;
 struct WindowPortPropertyData;
 class WindowTreeClientDelegate;
 class WindowTreeClientPrivate;
@@ skipping 10 matching lines @@
 //
 // WindowTreeClient is owned by the creator. Generally when the delegate gets
 // one of OnEmbedRootDestroyed() or OnLostConnection() it should delete the
 // WindowTreeClient.
 //
 // When WindowTreeClient is deleted all windows are deleted (and observers
 // notified).
 class AURA_EXPORT WindowTreeClient
     : NON_EXPORTED_BASE(public ui::mojom::WindowTreeClient),
       NON_EXPORTED_BASE(public ui::mojom::WindowManager),
+      public CaptureSynchronizerDelegate,
       public DragDropControllerHost,
       public WindowManagerClient,
       public WindowTreeHostMusDelegate,
-      public client::CaptureClientObserver,
       public client::FocusChangeObserver,
       public client::TransientWindowClientObserver {
  public:
   explicit WindowTreeClient(
       WindowTreeClientDelegate* delegate,
       WindowManagerDelegate* window_manager_delegate = nullptr,
       ui::mojom::WindowTreeClientRequest request = nullptr);
   ~WindowTreeClient() override;
 
   // Establishes the connection by way of the WindowTreeFactory.
@@ skipping 38 matching lines @@
       Id window_id,
       ui::mojom::CompositorFrameSinkType type,
       cc::mojom::MojoCompositorFrameSinkRequest compositor_frame_sink,
       cc::mojom::MojoCompositorFrameSinkClientPtr client);
 
   bool IsRoot(WindowMus* window) const { return roots_.count(window) > 0; }
 
   // Returns the root of this connection.
   std::set<Window*> GetRoots();
 
-  // Returns the Window with input capture; null if no window has requested
-  // input capture, or if another app has capture.
-  Window* GetCaptureWindow();
-
   // Returns the focused window; null if focus is not yet known or another app
   // is focused.
   Window* GetFocusedWindow();
 
   // Returns the current location of the mouse on screen. Note: this method may
   // race the asynchronous initialization; but in that case we return (0, 0).
   gfx::Point GetCursorScreenPoint();
 
   // See description in window_tree.mojom. When an existing pointer watcher is
   // updated or cleared then any future events from the server for that watcher
@@ skipping 10 matching lines @@
 
   // Cancels a in progress window move. (If no window is currently being moved,
   // does nothing.)
   void CancelWindowMove(Window* window);
 
   void AddObserver(WindowTreeClientObserver* observer);
   void RemoveObserver(WindowTreeClientObserver* observer);
 
  private:
   friend class InFlightBoundsChange;
-  friend class InFlightCaptureChange;
   friend class InFlightFocusChange;
   friend class InFlightPropertyChange;
   friend class InFlightVisibleChange;
   friend class WindowPortMus;
   friend class WindowTreeClientPrivate;
 
   using IdToWindowMap = std::map<Id, WindowMus*>;
 
   // TODO(sky): this assumes change_ids never wrap, which is a bad assumption.
   using InFlightMap = std::map<uint32_t, std::unique_ptr<InFlightChange>>;
 
   void RegisterWindowMus(WindowMus* window);
 
   WindowMus* GetWindowByServerId(Id id);
 
   // Returns true if the specified window was created by this client.
   bool WasCreatedByThisClient(const WindowMus* window) const;
 
   void SetFocusFromServer(WindowMus* window);
   void SetFocusFromServerImpl(client::FocusClient* focus_client,
                               WindowMus* window);
 
-  void SetCaptureFromServer(WindowMus* window);
-
   // Returns the oldest InFlightChange that matches |change|.
   InFlightChange* GetOldestInFlightChangeMatching(const InFlightChange& change);
 
   // See InFlightChange for details on how InFlightChanges are used.
   uint32_t ScheduleInFlightChange(std::unique_ptr<InFlightChange> change);
 
   // Returns true if there is an InFlightChange that matches |change|. If there
   // is an existing change SetRevertValueFrom() is invoked on it. Returns false
   // if there is no InFlightChange matching |change|.
   // See InFlightChange for details on how InFlightChanges are used.
@@ skipping 23 matching lines @@
                                int64_t display_id,
                                Window* content_window);
 
   WindowMus* NewWindowFromWindowData(
       WindowMus* parent,
       const ui::mojom::WindowDataPtr& window_data);
 
   // Sets the ui::mojom::WindowTree implementation.
   void SetWindowTree(ui::mojom::WindowTreePtr window_tree_ptr);
 
+  // Called when the connection to the server is established.
+  void WindowTreeConnectionEstablished(ui::mojom::WindowTree* window_tree);
+
   // Called when the ui::mojom::WindowTree connection is lost, deletes this.
   void OnConnectionLost();
 
   // Called when a Window property changes. If |key| is handled internally
   // (maps to a function on WindowTree) returns true.
   bool HandleInternalPropertyChanged(WindowMus* window, const void* key);
 
   // OnEmbed() calls into this. Exposed as a separate function for testing.
   void OnEmbedImpl(ui::mojom::WindowTree* window_tree,
                    ClientSpecificId client_id,
@@ skipping 170 matching lines @@
   void RemoveActivationParent(Window* window) override;
   void ActivateNextWindow() override;
   void SetUnderlaySurfaceOffsetAndExtendedHitArea(
       Window* window,
       const gfx::Vector2d& offset,
       const gfx::Insets& hit_area) override;
 
   // Overriden from client::FocusChangeObserver:
   void OnWindowFocused(Window* gained_focus, Window* lost_focus) override;
 
-  // Overriden from client::CaptureClientObserver:
-  void OnCaptureChanged(Window* lost_capture, Window* gained_capture) override;
-
   // Overriden from WindowTreeHostMusDelegate:
   void SetRootWindowBounds(Window* window, gfx::Rect* bounds) override;
 
   // Override from client::TransientWindowClientObserver:
   void OnTransientChildWindowAdded(Window* parent,
                                    Window* transient_child) override;
   void OnTransientChildWindowRemoved(Window* parent,
                                      Window* transient_child) override;
 
   // Overriden from DragDropControllerHost:
   uint32_t CreateChangeIdForDrag(WindowMus* window) override;
 
+  // Overrided from CaptureSynchronizerDelegate:
+  uint32_t CreateChangeIdForCapture(WindowMus* window) override;
+
   // The one int in |cursor_location_mapping_|. When we read from this
   // location, we must always read from it atomically.
   base::subtle::Atomic32* cursor_location_memory() {
     return reinterpret_cast<base::subtle::Atomic32*>(
         cursor_location_mapping_.get());
   }
 
   // This is set once and only once when we get OnEmbed(). It gives the unique
   // id for this client.
   ClientSpecificId client_id_;
 
   // Id assigned to the next window created.
   ClientSpecificId next_window_id_;
 
   // Id used for the next change id supplied to the server.
   uint32_t next_change_id_;
   InFlightMap in_flight_map_;
 
   WindowTreeClientDelegate* delegate_;
 
   WindowManagerDelegate* window_manager_delegate_;
 
   std::set<WindowMus*> roots_;
 
   IdToWindowMap windows_;
   std::map<ClientSpecificId, std::set<Window*>> embedded_windows_;
 
-  bool setting_capture_ = false;
-  WindowMus* window_setting_capture_to_ = nullptr;
-  WindowMus* capture_window_ = nullptr;
+  std::unique_ptr<CaptureSynchronizer> capture_synchronizer_;
 
   bool setting_focus_ = false;
   WindowMus* window_setting_focus_to_ = nullptr;
   WindowMus* focused_window_ = nullptr;
 
   mojo::Binding<ui::mojom::WindowTreeClient> binding_;
   ui::mojom::WindowTreePtr tree_ptr_;
   // Typically this is the value contained in |tree_ptr_|, but tests may
   // directly set this.
   ui::mojom::WindowTree* tree_;
@@ skipping 29 matching lines @@
   std::unique_ptr<DragDropControllerMus> drag_drop_controller_;
 
   base::WeakPtrFactory<WindowTreeClient> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(WindowTreeClient);
 };
 
 }  // namespace aura
 
 #endif  // UI_AURA_MUS_WINDOW_TREE_CLIENT_H_