ui/compositor/test/draw_waiter_for_test.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_COMPOSITOR_TEST_DRAW_WAITER_H_
   6 #define UI_COMPOSITOR_TEST_DRAW_WAITER_H_
   7
   8 #include "base/run_loop.h"
   9 #include "ui/compositor/compositor_observer.h"
  10
  11 class Compositor;
  12
  13 namespace ui {
  14
  15 // This is only to be used for test. It allows execution of other tasks on
  16 // the current message loop before the current task finishs (there is a
  17 // potential for re-entrancy).
  18 class DrawWaiterForTest : public CompositorObserver {
  19  public:
  20   // Waits for a draw to be issued by the compositor. If the test times out
  21   // here, there may be a logic error in the compositor code causing it
  22   // not to draw.
  23   static void WaitForCompositingStarted(Compositor* compositor);
  24
  25   // Waits for a swap to be completed from the compositor.
  26   static void WaitForCompositingEnded(Compositor* compositor);
  27
  28   // Waits for a commit instead of a draw.
  29   static void WaitForCommit(Compositor* compositor);
  30
  31  private:
  32   enum WaitEvent {
  33     WAIT_FOR_COMMIT,
  34     WAIT_FOR_COMPOSITING_STARTED,
  35     WAIT_FOR_COMPOSITING_ENDED,
  36   };
  37   DrawWaiterForTest(WaitEvent wait_event);
  38   ~DrawWaiterForTest();
  39
  40   void WaitImpl(Compositor* compositor);
  41
  42   // CompositorObserver implementation.
  43   void OnCompositingDidCommit(Compositor* compositor) override;
  44   void OnCompositingStarted(Compositor* compositor,
  45                             base::TimeTicks start_time) override;
  46   void OnCompositingEnded(Compositor* compositor) override;
  47   void OnCompositingAborted(Compositor* compositor) override;
  48   void OnCompositingLockStateChanged(Compositor* compositor) override;
  49   void OnCompositingShuttingDown(Compositor* compositor) override;
  50
  51   scoped_ptr<base::RunLoop> wait_run_loop_;
  52
  53   WaitEvent wait_event_;
  54
  55   DISALLOW_COPY_AND_ASSIGN(DrawWaiterForTest);
  56 };
  57
  58 }  // namespace ui
  59
  60 #endif  // UI_COMPOSITOR_TEST_DRAW_WAITER_H_