Tweaks to BoundsAnimator/SlideAnimation and TabStrip:

. Adds unit test for BoundsAnimator and SlideAnimation.
. Fixes leak in BoundsAnimator.
. Fixes possibility of deleting delegate twice.
. Makes sure delegate is notified when new animation is set for view.
. Fixes crashes in TabStrip that resulted from dragging a tab back in.

BUG=40475
TEST=make sure dragging tabs out/in to a tabstrip doesn't cause
  problems.

Review URL: http://codereview.chromium.org/1585020

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@43864 0039d316-1c4b-4281-b951-d872f2087c98

3 files changed, 215 insertions, 28 deletions

diff --git a/views/animation/bounds_animator.cc b/views/animation/bounds_animator.cc
index 65ba415..42da2ec 100644
--- a/views/animation/bounds_animator.cc
+++ b/views/animation/bounds_animator.cc
@@ -28,7 +28,7 @@ BoundsAnimator::~BoundsAnimator() {
   // Delete all the animations, but don't remove any child views. We assume the
   // view owns us and is going to be deleted anyway.
   for (ViewToDataMap::iterator i = data_.begin(); i != data_.end(); ++i)
-    CleanupData(&(i->second));
+    CleanupData(false, &(i->second), i->first);
 }
 
 void BoundsAnimator::AnimateViewTo(View* view,
@@ -36,14 +36,14 @@ void BoundsAnimator::AnimateViewTo(View* view,
                                    bool delete_when_done) {
   DCHECK_EQ(view->GetParent(), parent_);
 
-  scoped_ptr<Animation> current_animation;
+  Data existing_data;
 
-  if (data_.find(view) != data_.end()) {
-    // Currently animating this view, blow away the current animation and
-    // we'll create another animation below.
-    // We delay deleting the view until the end so that we don't prematurely
-    // send out notification that we're done.
-    current_animation.reset(ResetAnimationForView(view));
+  if (data_.count(view) > 0) {
+    // Don't immediatly delete the animation, that might trigger a callback from
+    // the animationcontainer.
+    existing_data = data_[view];
+
+    RemoveFromMaps(view);
   }
 
   // NOTE: we don't check if the view is already at the target location. Doing
@@ -60,6 +60,8 @@ void BoundsAnimator::AnimateViewTo(View* view,
   animation_to_view_[data.animation] = view;
 
   data.animation->Show();
+
+  CleanupData(true, &existing_data, NULL);
 }
 
 void BoundsAnimator::SetAnimationForView(View* view,
@@ -126,22 +128,25 @@ SlideAnimation* BoundsAnimator::CreateAnimation() {
   return animation;
 }
 
-void BoundsAnimator::RemoveFromMapsAndDelete(View* view) {
+void BoundsAnimator::RemoveFromMaps(View* view) {
   DCHECK(data_.count(view) > 0);
 
-  Data& data = data_[view];
-  animation_to_view_.erase(data.animation);
-  if (data.delete_when_done)
-    delete view;
+  animation_to_view_.erase(data_[view].animation);
   data_.erase(view);
 }
 
-void BoundsAnimator::CleanupData(Data* data) {
+void BoundsAnimator::CleanupData(bool send_cancel, Data* data, View* view) {
+  if (send_cancel && data->delegate)
+    data->delegate->AnimationCanceled(data->animation);
+
   if (data->delete_delegate_when_done) {
     delete static_cast<OwnedAnimationDelegate*>(data->delegate);
     data->delegate = NULL;
   }
 
+  if (data->delete_when_done)
+    delete view;
+
   delete data->animation;
   data->animation = NULL;
 }
@@ -190,12 +195,12 @@ void BoundsAnimator::AnimationEnded(const Animation* animation) {
   // Make a copy of the data as Remove empties out the maps.
   Data data = data_[view];
 
-  RemoveFromMapsAndDelete(view);
+  RemoveFromMaps(view);
 
   if (delegate)
     delegate->AnimationEnded(animation);
 
-  CleanupData(&data);
+  CleanupData(false, &data, view);
 }
 
 void BoundsAnimator::AnimationCanceled(const Animation* animation) {
@@ -205,12 +210,12 @@ void BoundsAnimator::AnimationCanceled(const Animation* animation) {
   // Make a copy of the data as Remove empties out the maps.
   Data data = data_[view];
 
-  RemoveFromMapsAndDelete(view);
+  RemoveFromMaps(view);
 
   if (delegate)
     delegate->AnimationCanceled(animation);
 
-  CleanupData(&data);
+  CleanupData(false, &data, view);
 }
 
 void BoundsAnimator::AnimationContainerProgressed(
diff --git a/views/animation/bounds_animator.h b/views/animation/bounds_animator.h
index ab2fde9..606c05f 100644
--- a/views/animation/bounds_animator.h
+++ b/views/animation/bounds_animator.h
@@ -50,7 +50,9 @@ class BoundsAnimator : public AnimationDelegate,
   // Starts animating |view| from its current bounds to |target|. If
   // |delete_when_done| is true the view is deleted when the animation
   // completes. If there is already an animation running for the view it's
-  // stopped and a new one started.
+  // stopped and a new one started. If an AnimationDelegate has been set for
+  // |view| it is removed (after being notified that the animation was
+  // canceled).
   void AnimateViewTo(View* view,
                      const gfx::Rect& target,
                      bool delete_when_done);
@@ -64,7 +66,7 @@ class BoundsAnimator : public AnimationDelegate,
   const SlideAnimation* GetAnimationForView(View* view);
 
   // Stops animating the specified view. If the view was scheduled for deletion
-  // it is deleted.
+  // it is deleted. This does nothing if |view| is not currently animating.
   void StopAnimatingView(View* view);
 
   // Sets the delegate for the animation created for the specified view. If
@@ -88,6 +90,10 @@ class BoundsAnimator : public AnimationDelegate,
     observer_ = observer;
   }
 
+ protected:
+  // Creates the animation to use for animating views.
+  virtual SlideAnimation* CreateAnimation();
+
  private:
   // Tracks data about the view being animated.
   struct Data {
@@ -120,15 +126,13 @@ class BoundsAnimator : public AnimationDelegate,
 
   typedef std::map<const Animation*, View*> AnimationToViewMap;
 
-  // Creates the animation to use for animating views.
-  SlideAnimation* CreateAnimation();
-
-  // Removes references to |view| and its animation as well as deleting |view|
-  // (if necessary). This does NOT delete the animation or delegate.
-  void RemoveFromMapsAndDelete(View* view);
+  // Removes references to |view| and its animation. This does NOT delete the
+  // animation or delegate.
+  void RemoveFromMaps(View* view);
 
-  // Does the necessary cleanup for |data|.
-  void CleanupData(Data* data);
+  // Does the necessary cleanup for |data|. If |send_cancel| is true and a
+  // delegate has been installed on |data| AnimationCanceled is invoked on it.
+  void CleanupData(bool send_cancel, Data* data, View* view);
 
   // Used when changing the animation for a view. This resets the maps for
   // the animation used by view and returns the current animation. Ownership
diff --git a/views/animation/bounds_animator_unittest.cc b/views/animation/bounds_animator_unittest.cc
new file mode 100644
index 0000000..74ea5f2
--- /dev/null
+++ b/views/animation/bounds_animator_unittest.cc
@@ -0,0 +1,178 @@
+// Copyright (c) 2010 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 "app/slide_animation.h"
+#include "app/test_animation_delegate.h"
+#include "testing/gtest/include/gtest/gtest.h"
+#include "views/animation/bounds_animator.h"
+#include "views/view.h"
+
+using views::BoundsAnimator;
+
+namespace {
+
+class TestBoundsAnimator : public BoundsAnimator {
+ public:
+  explicit TestBoundsAnimator(views::View* view) : BoundsAnimator(view) {
+  }
+
+ protected:
+  SlideAnimation* CreateAnimation() {
+    SlideAnimation* animation = BoundsAnimator::CreateAnimation();
+    animation->SetSlideDuration(10);
+    return animation;
+  }
+
+ private:
+  DISALLOW_COPY_AND_ASSIGN(TestBoundsAnimator);
+};
+
+class OwnedDelegate : public BoundsAnimator::OwnedAnimationDelegate {
+ public:
+  OwnedDelegate() {
+    deleted_ = false;
+    canceled_ = false;
+  }
+
+  ~OwnedDelegate() {
+    deleted_ = true;
+  }
+
+  static bool get_and_clear_deleted() {
+    bool value = deleted_;
+    deleted_ = false;
+    return value;
+  }
+
+  static bool get_and_clear_canceled() {
+    bool value = canceled_;
+    canceled_ = false;
+    return value;
+  }
+
+  // AnimationDelegate:
+  virtual void AnimationCanceled(const Animation* animation) {
+    canceled_ = true;
+  }
+
+ private:
+  static bool deleted_;
+  static bool canceled_;
+
+  DISALLOW_COPY_AND_ASSIGN(OwnedDelegate);
+};
+
+// static
+bool OwnedDelegate::deleted_ = false;
+
+// static
+bool OwnedDelegate::canceled_ = false;
+
+class TestView : public views::View {
+ public:
+  TestView() {}
+  virtual void SchedulePaint(const gfx::Rect& r, bool urgent) {
+    if (dirty_rect_.IsEmpty())
+      dirty_rect_ = r;
+    else
+      dirty_rect_ = dirty_rect_.Union(r);
+  }
+
+  const gfx::Rect& dirty_rect() const { return dirty_rect_; }
+
+ private:
+  gfx::Rect dirty_rect_;
+
+  DISALLOW_COPY_AND_ASSIGN(TestView);
+};
+
+}  // namespace
+
+class BoundsAnimatorTest : public testing::Test {
+ public:
+  BoundsAnimatorTest() : child_(new TestView()), animator_(&parent_) {
+    parent_.AddChildView(child_);
+  }
+
+  TestView* parent() { return &parent_; }
+  TestView* child() { return child_; }
+  TestBoundsAnimator* animator() { return &animator_; }
+
+ private:
+  MessageLoopForUI message_loop_;
+  TestView parent_;
+  TestView* child_;  // Owned by |parent_|.
+  TestBoundsAnimator animator_;
+
+  DISALLOW_COPY_AND_ASSIGN(BoundsAnimatorTest);
+};
+
+// Checks animate view to.
+TEST_F(BoundsAnimatorTest, AnimateViewTo) {
+  TestAnimationDelegate delegate;
+  gfx::Rect initial_bounds(0, 0, 10, 10);
+  child()->SetBounds(initial_bounds);
+  gfx::Rect target_bounds(10, 10, 20, 20);
+  animator()->AnimateViewTo(child(), target_bounds, false);
+  animator()->SetAnimationDelegate(child(), &delegate, false);
+
+  // The animator should be animating now.
+  EXPECT_TRUE(animator()->IsAnimating());
+
+  // Run the message loop; the delegate exits the loop when the animation is
+  // done.
+  MessageLoop::current()->Run();
+
+  // Make sure the bounds match of the view that was animated match.
+  EXPECT_EQ(target_bounds, child()->bounds());
+
+  // The parent should have been told to repaint as the animation progressed.
+  // The resulting rect is the union of the original and target bounds.
+  EXPECT_EQ(target_bounds.Union(initial_bounds), parent()->dirty_rect());
+}
+
+// Make sure an AnimationDelegate is deleted when canceled.
+TEST_F(BoundsAnimatorTest, DeleteDelegateOnCancel) {
+  animator()->AnimateViewTo(child(), gfx::Rect(0, 0, 10, 10), false);
+  animator()->SetAnimationDelegate(child(), new OwnedDelegate(), true);
+
+  animator()->Cancel();
+
+  // The animator should no longer be animating.
+  EXPECT_FALSE(animator()->IsAnimating());
+
+  // The cancel should both cancel the delegate and delete it.
+  EXPECT_TRUE(OwnedDelegate::get_and_clear_canceled());
+  EXPECT_TRUE(OwnedDelegate::get_and_clear_deleted());
+}
+
+// Make sure an AnimationDelegate is deleted when another animation is
+// scheduled.
+TEST_F(BoundsAnimatorTest, DeleteDelegateOnNewAnimate) {
+  animator()->AnimateViewTo(child(), gfx::Rect(0, 0, 10, 10), false);
+  animator()->SetAnimationDelegate(child(), new OwnedDelegate(), true);
+
+  animator()->AnimateViewTo(child(), gfx::Rect(0, 0, 10, 10), false);
+
+  // Starting a new animation should both cancel the delegate and delete it.
+  EXPECT_TRUE(OwnedDelegate::get_and_clear_deleted());
+  EXPECT_TRUE(OwnedDelegate::get_and_clear_canceled());
+}
+
+// Makes sure StopAnimating works.
+TEST_F(BoundsAnimatorTest, StopAnimating) {
+  scoped_ptr<OwnedDelegate> delegate(new OwnedDelegate());
+
+  animator()->AnimateViewTo(child(), gfx::Rect(0, 0, 10, 10), false);
+  animator()->SetAnimationDelegate(child(), new OwnedDelegate(), true);
+
+  animator()->StopAnimatingView(child());
+
+  // Shouldn't be animating now.
+  EXPECT_FALSE(animator()->IsAnimating());
+
+  // Stopping should both cancel the delegate and delete it.
+  EXPECT_TRUE(OwnedDelegate::get_and_clear_deleted());
+  EXPECT_TRUE(OwnedDelegate::get_and_clear_canceled());
+}