cc: Make PrepareToDraw return an enum for why it aborts

cc/trees/layer_tree_host_unittest_damage.cc

 // Copyright 2012 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 "cc/trees/layer_tree_host.h"
 
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/location.h"
 #include "base/message_loop/message_loop_proxy.h"
@@ skipping 30 matching lines @@
   }
 
   virtual void DidCommitAndDrawFrame() OVERRIDE {
     switch (layer_tree_host()->source_frame_number()) {
       case 1:
         layer_tree_host()->SetNeedsRedraw();
         break;
     }
   }
 
-  virtual bool PrepareToDrawOnThread(LayerTreeHostImpl* impl,
-                                     LayerTreeHostImpl::FrameData* frame_data,
-                                     bool result) OVERRIDE {
-    EXPECT_TRUE(result);
+  virtual DrawSwapReadbackResult::DrawResult PrepareToDrawOnThread(
+      LayerTreeHostImpl* impl,
+      LayerTreeHostImpl::FrameData* frame_data,
+      DrawSwapReadbackResult::DrawResult draw_result) OVERRIDE {
+    EXPECT_EQ(DrawSwapReadbackResult::DRAW_SUCCESS, draw_result);
 
     RenderSurfaceImpl* root_surface =
         impl->active_tree()->root_layer()->render_surface();
     gfx::RectF root_damage =
         root_surface->damage_tracker()->current_damage_rect();
 
     switch (draw_count_) {
       case 0:
         // The first frame has full damage.
         EXPECT_EQ(gfx::RectF(10.f, 10.f).ToString(), root_damage.ToString());
         break;
       case 1:
         // The second frame has full damage.
         EXPECT_EQ(gfx::RectF(10.f, 10.f).ToString(), root_damage.ToString());
         EndTest();
         break;
       case 2:
         NOTREACHED();
     }
 
     ++draw_count_;
-    return result;
+    return draw_result;
   }
 
   virtual void AfterTest() OVERRIDE {}
 
   int draw_count_;
   FakeContentLayerClient client_;
 };
 
 SINGLE_AND_MULTI_THREAD_TEST_F(LayerTreeHostDamageTestSetNeedsRedraw);
 
@@ skipping 15 matching lines @@
   }
 
   virtual void DidCommitAndDrawFrame() OVERRIDE {
     switch (layer_tree_host()->source_frame_number()) {
       case 1:
         layer_tree_host()->SetViewportSize(gfx::Size(15, 15));
         break;
     }
   }
 
-  virtual bool PrepareToDrawOnThread(LayerTreeHostImpl* impl,
-                                     LayerTreeHostImpl::FrameData* frame_data,
-                                     bool result) OVERRIDE {
-    EXPECT_TRUE(result);
+  virtual DrawSwapReadbackResult::DrawResult PrepareToDrawOnThread(
+      LayerTreeHostImpl* impl,
+      LayerTreeHostImpl::FrameData* frame_data,
+      DrawSwapReadbackResult::DrawResult draw_result) OVERRIDE {
+    EXPECT_EQ(DrawSwapReadbackResult::DRAW_SUCCESS, draw_result);
 
     RenderSurfaceImpl* root_surface =
         impl->active_tree()->root_layer()->render_surface();
     gfx::RectF root_damage =
         root_surface->damage_tracker()->current_damage_rect();
 
     switch (draw_count_) {
       case 0:
         // The first frame has full damage.
         EXPECT_EQ(gfx::RectF(10.f, 10.f).ToString(), root_damage.ToString());
         break;
       case 1:
         // The second frame has full damage.
         EXPECT_EQ(gfx::RectF(15.f, 15.f).ToString(), root_damage.ToString());
         EndTest();
         break;
       case 2:
         NOTREACHED();
     }
 
     ++draw_count_;
-    return result;
+    return draw_result;
   }
 
   virtual void AfterTest() OVERRIDE {}
 
   int draw_count_;
   FakeContentLayerClient client_;
 };
 
 SINGLE_AND_MULTI_THREAD_TEST_F(LayerTreeHostDamageTestSetViewportSize);
 
@@ skipping 12 matching lines @@
 
     // Most of the layer isn't visible.
     content_ = FakeContentLayer::Create(&client_);
     content_->SetBounds(gfx::Size(2000, 100));
     root->AddChild(content_);
 
     layer_tree_host()->SetRootLayer(root);
     LayerTreeHostDamageTest::SetupTree();
   }
 
-  virtual bool PrepareToDrawOnThread(LayerTreeHostImpl* host_impl,
-                                     LayerTreeHostImpl::FrameData* frame_data,
-                                     bool result) OVERRIDE {
-    EXPECT_TRUE(result);
+  virtual DrawSwapReadbackResult::DrawResult PrepareToDrawOnThread(
+      LayerTreeHostImpl* host_impl,
+      LayerTreeHostImpl::FrameData* frame_data,
+      DrawSwapReadbackResult::DrawResult draw_result) OVERRIDE {
+    EXPECT_EQ(DrawSwapReadbackResult::DRAW_SUCCESS, draw_result);
 
     int source_frame = host_impl->active_tree()->source_frame_number();
     switch (source_frame) {
       case 0:
         // The first frame has damage, so we should draw and swap.
         ++expect_swap_and_succeed_;
         break;
       case 1:
         // The second frame has no damage, so we should not draw and swap.
         break;
       case 2:
         // The third frame has damage again, so we should draw and swap.
         ++expect_swap_and_succeed_;
         break;
       case 3:
         // The fourth frame has no visible damage, so we should not draw and
         // swap.
         EndTest();
         break;
     }
-    return result;
+    return draw_result;
   }
 
   virtual void SwapBuffersOnThread(LayerTreeHostImpl* host_impl,
                                    bool result) OVERRIDE {
     ++did_swaps_;
     if (result)
       ++did_swap_and_succeed_;
     EXPECT_EQ(expect_swap_and_succeed_, did_swap_and_succeed_);
   }
 
@@ skipping 44 matching lines @@
 
     // Most of the layer isn't visible.
     content_ = FakeContentLayer::Create(&client_);
     content_->SetBounds(gfx::Size(100, 100));
     root->AddChild(content_);
 
     layer_tree_host()->SetRootLayer(root);
     LayerTreeHostDamageTest::SetupTree();
   }
 
-  virtual bool PrepareToDrawOnThread(LayerTreeHostImpl* host_impl,
-                                     LayerTreeHostImpl::FrameData* frame_data,
-                                     bool result) OVERRIDE {
-    EXPECT_TRUE(result);
+  virtual DrawSwapReadbackResult::DrawResult PrepareToDrawOnThread(
+      LayerTreeHostImpl* host_impl,
+      LayerTreeHostImpl::FrameData* frame_data,
+      DrawSwapReadbackResult::DrawResult draw_result) OVERRIDE {
+    EXPECT_EQ(DrawSwapReadbackResult::DRAW_SUCCESS, draw_result);
 
     int source_frame = host_impl->active_tree()->source_frame_number();
     switch (source_frame) {
       case 0:
         // The first frame draws and clears any damage.
         break;
       case 1: {
         // The second frame is a readback, we should have damage in the readback
         // rect, but not swap.
         RenderSurfaceImpl* root_surface =
             host_impl->active_tree()->root_layer()->render_surface();
         gfx::RectF root_damage =
             root_surface->damage_tracker()->current_damage_rect();
         root_damage.Intersect(root_surface->content_rect());
         EXPECT_TRUE(root_damage.Contains(gfx::Rect(3, 3, 1, 1)));
         break;
       }
       case 2:
         // CompositeAndReadback causes a follow-up commit.
         break;
       case 3:
         NOTREACHED();
         break;
     }
-    return result;
+    return draw_result;
   }
 
   virtual void DidCommitAndDrawFrame() OVERRIDE {
     int next_frame = layer_tree_host()->source_frame_number();
     switch (next_frame) {
       case 1: {
         char pixels[4];
         layer_tree_host()->CompositeAndReadback(static_cast<void*>(&pixels),
                                                 gfx::Rect(3, 3, 1, 1));
         EndTest();
@@ skipping 21 matching lines @@
 
     root_->SetBounds(gfx::Size(500, 500));
     child_->SetPosition(gfx::Point(100, 100));
     child_->SetBounds(gfx::Size(30, 30));
 
     root_->AddChild(child_);
     layer_tree_host()->SetRootLayer(root_);
     LayerTreeHostDamageTest::SetupTree();
   }
 
-  virtual bool PrepareToDrawOnThread(LayerTreeHostImpl* host_impl,
-                                     LayerTreeHostImpl::FrameData* frame_data,
-                                     bool result) OVERRIDE {
-    EXPECT_TRUE(result);
+  virtual DrawSwapReadbackResult::DrawResult PrepareToDrawOnThread(
+      LayerTreeHostImpl* host_impl,
+      LayerTreeHostImpl::FrameData* frame_data,
+      DrawSwapReadbackResult::DrawResult draw_result) OVERRIDE {
+    EXPECT_EQ(DrawSwapReadbackResult::DRAW_SUCCESS, draw_result);
 
     RenderSurfaceImpl* root_surface =
         host_impl->active_tree()->root_layer()->render_surface();
     gfx::RectF root_damage =
         root_surface->damage_tracker()->current_damage_rect();
     root_damage.Intersect(root_surface->content_rect());
 
     int source_frame = host_impl->active_tree()->source_frame_number();
     switch (source_frame) {
       case 0:
@@ skipping 48 matching lines @@
         break;
       case 4:
         // The whole frame is damaged.
         EXPECT_EQ(gfx::RectF(root_surface->content_rect()).ToString(),
                   root_damage.ToString());
         EXPECT_FALSE(frame_data->has_no_damage);
 
         EndTest();
         break;
     }
-    return result;
+    return draw_result;
   }
 
   virtual void DidCommitAndDrawFrame() OVERRIDE {
     if (!TestEnded())
       layer_tree_host()->SetNeedsCommit();
 
     if (!child_damage_rect_.IsEmpty()) {
       child_->SetNeedsDisplayRect(child_damage_rect_);
       child_damage_rect_ = gfx::RectF();
     }
@@ skipping 42 matching lines @@
   FakeContentLayerClient client_;
 };
 
 class LayerTreeHostDamageTestScrollbarDoesDamage
     : public LayerTreeHostScrollbarDamageTest {
   virtual void BeginTest() OVERRIDE {
     did_swaps_ = 0;
     PostSetNeedsCommitToMainThread();
   }
 
-  virtual bool PrepareToDrawOnThread(LayerTreeHostImpl* host_impl,
-                                     LayerTreeHostImpl::FrameData* frame_data,
-                                     bool result) OVERRIDE {
-    EXPECT_TRUE(result);
+  virtual DrawSwapReadbackResult::DrawResult PrepareToDrawOnThread(
+      LayerTreeHostImpl* host_impl,
+      LayerTreeHostImpl::FrameData* frame_data,
+      DrawSwapReadbackResult::DrawResult draw_result) OVERRIDE {
+    EXPECT_EQ(DrawSwapReadbackResult::DRAW_SUCCESS, draw_result);
     RenderSurfaceImpl* root_surface =
         host_impl->active_tree()->root_layer()->render_surface();
     gfx::RectF root_damage =
         root_surface->damage_tracker()->current_damage_rect();
     root_damage.Intersect(root_surface->content_rect());
     switch (did_swaps_) {
       case 0:
         // The first frame has damage, so we should draw and swap.
         break;
       case 1:
         // The second frame should not damage the scrollbars.
         EXPECT_FALSE(root_damage.Intersects(gfx::Rect(300, 300, 10, 100)));
         break;
       case 2:
         // The third frame should damage the scrollbars.
         EXPECT_TRUE(root_damage.Contains(gfx::Rect(300, 300, 10, 100)));
         break;
       case 3:
         // The fourth frame should damage the scrollbars.
         EXPECT_TRUE(root_damage.Contains(gfx::Rect(300, 300, 10, 100)));
         EndTest();
         break;
     }
-    return result;
+    return draw_result;
   }
 
   virtual void SwapBuffersOnThread(LayerTreeHostImpl* host_impl,
                                    bool result) OVERRIDE {
     ++did_swaps_;
     EXPECT_TRUE(result);
     LayerImpl* root = host_impl->active_tree()->root_layer();
     LayerImpl* scroll_layer = root->children()[0];
     switch (did_swaps_) {
       case 1:
@@ skipping 23 matching lines @@
 
 MULTI_THREAD_TEST_F(LayerTreeHostDamageTestScrollbarDoesDamage);
 
 class LayerTreeHostDamageTestScrollbarCommitDoesNoDamage
     : public LayerTreeHostScrollbarDamageTest {
   virtual void BeginTest() OVERRIDE {
     did_swaps_ = 0;
     PostSetNeedsCommitToMainThread();
   }
 
-  virtual bool PrepareToDrawOnThread(LayerTreeHostImpl* host_impl,
-                                     LayerTreeHostImpl::FrameData* frame_data,
-                                     bool result) OVERRIDE {
-    EXPECT_TRUE(result);
+  virtual DrawSwapReadbackResult::DrawResult PrepareToDrawOnThread(
+      LayerTreeHostImpl* host_impl,
+      LayerTreeHostImpl::FrameData* frame_data,
+      DrawSwapReadbackResult::DrawResult draw_result) OVERRIDE {
+    EXPECT_EQ(DrawSwapReadbackResult::DRAW_SUCCESS, draw_result);
     RenderSurfaceImpl* root_surface =
         host_impl->active_tree()->root_layer()->render_surface();
     gfx::RectF root_damage =
         root_surface->damage_tracker()->current_damage_rect();
     root_damage.Intersect(root_surface->content_rect());
     int frame = host_impl->active_tree()->source_frame_number();
     switch (did_swaps_) {
       case 0:
         // The first frame has damage, so we should draw and swap.
         EXPECT_EQ(0, frame);
         break;
       case 1:
         // The second frame has scrolled, so the scrollbar should be damaged.
         EXPECT_EQ(0, frame);
         EXPECT_TRUE(root_damage.Contains(gfx::Rect(300, 300, 10, 100)));
         break;
       case 2:
         // The third frame (after the commit) has no changes, so it shouldn't.
         EXPECT_EQ(1, frame);
         EXPECT_FALSE(root_damage.Intersects(gfx::Rect(300, 300, 10, 100)));
         break;
       default:
         NOTREACHED();
         break;
     }
-    return result;
+    return draw_result;
   }
 
   virtual void SwapBuffersOnThread(LayerTreeHostImpl* host_impl,
                                    bool result) OVERRIDE {
     ++did_swaps_;
     EXPECT_TRUE(result);
     LayerImpl* root = host_impl->active_tree()->root_layer();
     LayerImpl* scroll_layer = root->children()[0];
     switch (did_swaps_) {
       case 1:
@@ skipping 40 matching lines @@
     scoped_refptr<FakePictureLayer> root = FakePictureLayer::Create(&client_);
     root->SetBounds(gfx::Size(500, 500));
     layer_tree_host()->SetRootLayer(root);
     LayerTreeHostDamageTest::SetupTree();
 
     swap_count_ = 0;
     prepare_to_draw_count_ = 0;
     update_visible_tile_count_ = 0;
   }
 
-  virtual bool PrepareToDrawOnThread(LayerTreeHostImpl* host_impl,
-                                     LayerTreeHostImpl::FrameData* frame_data,
-                                     bool result) OVERRIDE {
-    EXPECT_TRUE(result);
+  virtual DrawSwapReadbackResult::DrawResult PrepareToDrawOnThread(
+      LayerTreeHostImpl* host_impl,
+      LayerTreeHostImpl::FrameData* frame_data,
+      DrawSwapReadbackResult::DrawResult draw_result) OVERRIDE {
+    EXPECT_EQ(DrawSwapReadbackResult::DRAW_SUCCESS, draw_result);
     prepare_to_draw_count_++;
     switch (prepare_to_draw_count_) {
       case 1:
         // Detect that we have an incomplete tile, during the first frame.
         // The first frame should have damage.
         frame_data->contains_incomplete_tile = true;
         DCHECK(!frame_data->has_no_damage);
         break;
       case 2:
         // Make a no-damage frame. We early out and can't detect
         // incomplete tiles, even if they still exist.
         frame_data->contains_incomplete_tile = false;
         frame_data->has_no_damage = true;
         break;
       case 3:
         // Trigger the last swap for the completed tile.
         frame_data->contains_incomplete_tile = false;
         frame_data->has_no_damage = false;
         EndTest();
         break;
       default:
         NOTREACHED();
         break;
     }
 
-    return result;
+    return draw_result;
   }
 
   virtual void UpdateVisibleTilesOnThread(
       LayerTreeHostImpl* host_impl) OVERRIDE {
     // Simulate creating some visible tiles (that trigger prepare-to-draws).
     // The first we make into a no-damage-frame during prepare-to-draw (see
     // above). This is to ensure we still get UpdateVisibleTiles calls after
     // a no-damage or aborted frame.
     update_visible_tile_count_++;
     switch (update_visible_tile_count_) {
@@ skipping 27 matching lines @@
   FakeContentLayerClient client_;
   int swap_count_;
   int prepare_to_draw_count_;
   int update_visible_tile_count_;
 };
 
 MULTI_THREAD_TEST_F(LayerTreeHostDamageTestVisibleTilesStillTriggerDraws);
 
 }  // namespace
 }  // namespace cc