Refactors DimWindow and moves to ash/common

ash/common/wm_window.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 ASH_COMMON_WM_WINDOW_H_
 #define ASH_COMMON_WM_WINDOW_H_
 
 #include <memory>
 #include <vector>
 
 #include "ash/ash_export.h"
 #include "base/strings/string16.h"
+#include "base/supports_user_data.h"

[James Cook, 2016/09/09 00:03:36]

nit: either skip this or skip the forward declare below

[sky, 2016/09/09 03:50:04]

Done.

 #include "base/time/time.h"
 #include "ui/base/ui_base_types.h"
 #include "ui/compositor/layer_animation_element.h"
 #include "ui/wm/core/window_animations.h"
 #include "ui/wm/public/window_types.h"
 
+namespace base {
+class SupportsUserData;
+}
+
 namespace display {
 class Display;
 }
 
 namespace gfx {
 class Point;
 class Rect;
 class Size;
 class Transform;
 }
@@ skipping 28 matching lines @@
 class ASH_EXPORT WmWindow {
  public:
   // See comments in SetBoundsInScreen().
   enum class BoundsInScreenBehavior {
     USE_LOCAL_COORDINATES,
     USE_SCREEN_COORDINATES,
   };
 
   using Windows = std::vector<WmWindow*>;
 
+  virtual void Destroy() = 0;
+
   WmWindow* GetRootWindow() {
     return const_cast<WmWindow*>(
         const_cast<const WmWindow*>(this)->GetRootWindow());
   }
   virtual const WmWindow* GetRootWindow() const = 0;
   virtual WmRootWindowController* GetRootWindowController() = 0;
 
   // TODO(sky): fix constness.
   virtual WmShell* GetShell() const = 0;
 
@@ skipping 38 matching lines @@
   virtual bool IsVisible() const = 0;
 
   virtual void SetOpacity(float opacity) = 0;
   virtual float GetTargetOpacity() const = 0;
 
   virtual void SetTransform(const gfx::Transform& transform) = 0;
   virtual gfx::Transform GetTargetTransform() const = 0;
 
   virtual bool IsSystemModal() const = 0;
 
+  // Returns the base::SupportsUserData* owned by |this| that can be used to
+  // store arbitrary data.
+  base::SupportsUserData* GetUserData();
+
   virtual bool GetBoolProperty(WmWindowProperty key) = 0;
   virtual int GetIntProperty(WmWindowProperty key) = 0;
   virtual void SetIntProperty(WmWindowProperty key, int value) = 0;
 
   // Returns null if there are no details.
   virtual ShelfItemDetails* GetShelfItemDetails() = 0;
   virtual void SetShelfItemDetails(const ShelfItemDetails& details) = 0;
   virtual void ClearShelfItemDetails() = 0;
 
   wm::WindowState* GetWindowState() {
@@ skipping 20 matching lines @@
         const_cast<const WmWindow*>(this)->GetTransientParent());
   }
   virtual const WmWindow* GetTransientParent() const = 0;
   virtual Windows GetTransientChildren() = 0;
 
   virtual void SetLayoutManager(
       std::unique_ptr<WmLayoutManager> layout_manager) = 0;
   virtual WmLayoutManager* GetLayoutManager() = 0;
 
   // |type| is WindowVisibilityAnimationType. Has to be an int to match aura.
+  virtual void SetVisibilityChangesAnimated() = 0;

[James Cook, 2016/09/09 00:03:36]

nit: move above comment.

Also, a comment for this function would be nice. I guess visibility changes
aren't animated by default?

[sky, 2016/09/09 03:50:04]

I added a pointer to the function it mirrors.

   virtual void SetVisibilityAnimationType(int type) = 0;
   virtual void SetVisibilityAnimationDuration(base::TimeDelta delta) = 0;
   virtual void SetVisibilityAnimationTransition(
       ::wm::WindowVisibilityAnimationTransition transition) = 0;
   virtual void Animate(::wm::WindowAnimationType type) = 0;
   virtual void StopAnimatingProperty(
       ui::LayerAnimationElement::AnimatableProperty property) = 0;
   virtual void SetChildWindowVisibilityChangesAnimated() = 0;
 
   // See description in ui::Layer.
@@ skipping 133 matching lines @@
   // Adds or removes a handler to receive events targeted at this window, before
   // this window handles the events itself; the handler does not recieve events
   // from embedded windows. This only supports windows with internal widgets;
   // see GetInternalWidget(). Ownership of the handler is not transferred.
   //
   // Also note that the target of these events is always an aura::Window.
   virtual void AddLimitedPreTargetHandler(ui::EventHandler* handler) = 0;
   virtual void RemoveLimitedPreTargetHandler(ui::EventHandler* handler) = 0;
 
  protected:
-  virtual ~WmWindow() {}
+  WmWindow();
+  virtual ~WmWindow();
+
+  void DestroyUserData();
+
+ private:
+  class SupportsUserDataImpl;
+
+  std::unique_ptr<SupportsUserDataImpl> user_data_;
 };
 
 }  // namespace ash
 
 #endif  // ASH_COMMON_WM_WINDOW_H_